diff --git a/.github/workflows/docs-nav.yaml b/.github/workflows/docs-nav.yaml index fc4c8152c..0f1018958 100644 --- a/.github/workflows/docs-nav.yaml +++ b/.github/workflows/docs-nav.yaml @@ -8,10 +8,17 @@ on: workflow_dispatch: pull_request: paths: - - "docs/sdks/**" + - "docs/**" + - "scripts/sanitize-docs-emoji.sh" - "scripts/gen-docs-nav.sh" - ".github/workflows/docs-nav.yaml" +# Shared with speakeasy_run_on_pr.yaml: both push generated files to the PR +# head branch, so they must not run at the same time on the same PR. +concurrency: + group: generated-files-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: false + jobs: gen-docs-nav: runs-on: ubuntu-latest @@ -22,11 +29,17 @@ jobs: ref: ${{ github.event.pull_request.head.ref }} token: ${{ secrets.GITHUB_TOKEN }} + - name: Sanitize generated docs emoji + run: scripts/sanitize-docs-emoji.sh + # jq is preinstalled on GitHub-hosted ubuntu runners. - name: Regenerate docs navigation run: scripts/gen-docs-nav.sh - - name: Auto-commit docs.json navigation + # On manual dispatch there is no PR head ref, so checkout falls back to + # main; never auto-commit there. + - name: Auto-commit generated docs files + if: github.event_name == 'pull_request' uses: int128/update-generated-files-action@v2 with: - commit-message: "Chore: regenerate docs navigation" + commit-message: "Chore: sanitize generated docs emoji" diff --git a/.github/workflows/speakeasy_run_on_pr.yaml b/.github/workflows/speakeasy_run_on_pr.yaml index 75c6bd8b5..fedab66f8 100644 --- a/.github/workflows/speakeasy_run_on_pr.yaml +++ b/.github/workflows/speakeasy_run_on_pr.yaml @@ -10,6 +10,12 @@ on: paths: - .speakeasy/in.openapi.yaml +# Shared with docs-nav.yaml: both push generated files to the PR head branch, +# so they must not run at the same time on the same PR. +concurrency: + group: generated-files-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: false + jobs: run-speakeasy: runs-on: ubuntu-latest @@ -44,6 +50,9 @@ jobs: env: SPEAKEASY_API_KEY: ${{ secrets.SPEAKEASY_API_KEY }} + - name: Sanitize generated docs emoji + run: scripts/sanitize-docs-emoji.sh + - name: Regenerate docs navigation run: scripts/gen-docs-nav.sh diff --git a/docs/models/aabenchmarkentry.mdx b/docs/models/aabenchmarkentry.mdx index a4101e6cf..7f0bad32e 100644 --- a/docs/models/aabenchmarkentry.mdx +++ b/docs/models/aabenchmarkentry.mdx @@ -20,6 +20,6 @@ let value: AABenchmarkEntry = { | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `agenticIndex` | *number* | :heavy_check_mark: | Artificial Analysis Agentic Index score | 55.8 | -| `codingIndex` | *number* | :heavy_check_mark: | Artificial Analysis Coding Index score | 63.2 | -| `intelligenceIndex` | *number* | :heavy_check_mark: | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file +| `agenticIndex` | *number* | ✅ | Artificial Analysis Agentic Index score | 55.8 | +| `codingIndex` | *number* | ✅ | Artificial Analysis Coding Index score | 63.2 | +| `intelligenceIndex` | *number* | ✅ | Artificial Analysis Intelligence Index score | 71.4 | \ No newline at end of file diff --git a/docs/models/activityitem.mdx b/docs/models/activityitem.mdx index 796837dc9..a07dbd302 100644 --- a/docs/models/activityitem.mdx +++ b/docs/models/activityitem.mdx @@ -27,16 +27,16 @@ let value: ActivityItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byokUsageInference` | *number* | :heavy_check_mark: | BYOK inference cost in USD (external credits spent) | 0.012 | -| `cachedTokens` | *number* | :heavy_check_mark: | Total prompt tokens read from the provider prompt cache (cache hits). Generally a subset of `prompt_tokens`; for replayed response-cache hits the provider may report the two counters over disjoint token sets, so `cached_tokens` can exceed `prompt_tokens`. | 10 | -| `completionTokens` | *number* | :heavy_check_mark: | Total completion tokens generated | 125 | -| `date` | *string* | :heavy_check_mark: | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | -| `endpointId` | *string* | :heavy_check_mark: | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | -| `model` | *string* | :heavy_check_mark: | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | -| `modelPermaslug` | *string* | :heavy_check_mark: | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | -| `promptTokens` | *number* | :heavy_check_mark: | Total prompt tokens used | 50 | -| `providerName` | *string* | :heavy_check_mark: | Name of the provider serving this endpoint | OpenAI | -| `reasoningTokens` | *number* | :heavy_check_mark: | Total reasoning tokens used | 25 | -| `requests` | *number* | :heavy_check_mark: | Number of requests made | 5 | -| `usage` | *number* | :heavy_check_mark: | Total cost in USD (OpenRouter credits spent) | 0.015 | -| `workspaceId` | *string* | :heavy_minus_sign: | ID of the workspace this activity is attributed to. Only present when `group_by=workspace` is passed; the response is then split per workspace. Activity recorded before workspace resolution existed is attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `byokUsageInference` | *number* | ✅ | BYOK inference cost in USD (external credits spent) | 0.012 | +| `cachedTokens` | *number* | ✅ | Total prompt tokens read from the provider prompt cache (cache hits). Generally a subset of `prompt_tokens`; for replayed response-cache hits the provider may report the two counters over disjoint token sets, so `cached_tokens` can exceed `prompt_tokens`. | 10 | +| `completionTokens` | *number* | ✅ | Total completion tokens generated | 125 | +| `date` | *string* | ✅ | Date of the activity (YYYY-MM-DD format) | 2025-08-24 | +| `endpointId` | *string* | ✅ | Unique identifier for the endpoint | 550e8400-e29b-41d4-a716-446655440000 | +| `model` | *string* | ✅ | Model slug (e.g., "openai/gpt-4.1") | openai/gpt-4.1 | +| `modelPermaslug` | *string* | ✅ | Model permaslug (e.g., "openai/gpt-4.1-2025-04-14") | openai/gpt-4.1-2025-04-14 | +| `promptTokens` | *number* | ✅ | Total prompt tokens used | 50 | +| `providerName` | *string* | ✅ | Name of the provider serving this endpoint | OpenAI | +| `reasoningTokens` | *number* | ✅ | Total reasoning tokens used | 25 | +| `requests` | *number* | ✅ | Number of requests made | 5 | +| `usage` | *number* | ✅ | Total cost in USD (OpenRouter credits spent) | 0.015 | +| `workspaceId` | *string* | ➖ | ID of the workspace this activity is attributed to. Only present when `group_by=workspace` is passed; the response is then split per workspace. Activity recorded before workspace resolution existed is attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/activityresponse.mdx b/docs/models/activityresponse.mdx index 529b6182c..84256c18f 100644 --- a/docs/models/activityresponse.mdx +++ b/docs/models/activityresponse.mdx @@ -31,4 +31,4 @@ let value: ActivityResponse = { | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `data` | [models.ActivityItem](../models/activityitem.mdx)[] | :heavy_check_mark: | List of activity items | \ No newline at end of file +| `data` | [models.ActivityItem](../models/activityitem.mdx)[] | ✅ | List of activity items | \ No newline at end of file diff --git a/docs/models/additionaltoolsitem.mdx b/docs/models/additionaltoolsitem.mdx index 4ec7672df..2614dfa4c 100644 --- a/docs/models/additionaltoolsitem.mdx +++ b/docs/models/additionaltoolsitem.mdx @@ -24,7 +24,7 @@ let value: AdditionalToolsItem = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `role` | [models.AdditionalToolsItemRole](../models/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A | -| `tools` | *models.AdditionalToolsItemToolUnion*[] | :heavy_check_mark: | N/A | -| `type` | [models.TypeAdditionalTools](../models/typeadditionaltools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `id` | *string* | ➖ | N/A | +| `role` | [models.AdditionalToolsItemRole](../models/additionaltoolsitemrole.mdx) | ✅ | N/A | +| `tools` | *models.AdditionalToolsItemToolUnion*[] | ✅ | N/A | +| `type` | [models.TypeAdditionalTools](../models/typeadditionaltools.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/additionaltoolsitemtool.mdx b/docs/models/additionaltoolsitemtool.mdx index 9e457b8ff..d39844f49 100644 --- a/docs/models/additionaltoolsitemtool.mdx +++ b/docs/models/additionaltoolsitemtool.mdx @@ -16,5 +16,5 @@ let value: AdditionalToolsItemTool = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *string* | ✅ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/additionaltoolsitemtoolfunction.mdx b/docs/models/additionaltoolsitemtoolfunction.mdx index d9b2bb1b8..d504a3e30 100644 --- a/docs/models/additionaltoolsitemtoolfunction.mdx +++ b/docs/models/additionaltoolsitemtoolfunction.mdx @@ -39,10 +39,10 @@ let value: AdditionalToolsItemToolFunction = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `parameters` | Record\ | :heavy_check_mark: | N/A | | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | | -| `type` | [models.AdditionalToolsItemTypeFunction](../models/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A | | -| `async` | *boolean* | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `deferLoading` | *boolean* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `description` | *string* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `parameters` | Record\ | ✅ | N/A | | +| `strict` | *boolean* | ➖ | N/A | | +| `type` | [models.AdditionalToolsItemTypeFunction](../models/additionaltoolsitemtypefunction.mdx) | ✅ | N/A | | +| `async` | *boolean* | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `deferLoading` | *boolean* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/advisorreasoning.mdx b/docs/models/advisorreasoning.mdx index 99f59604d..b453faa0a 100644 --- a/docs/models/advisorreasoning.mdx +++ b/docs/models/advisorreasoning.mdx @@ -16,5 +16,5 @@ let value: AdvisorReasoning = {}; | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `effort` | [models.AdvisorReasoningEffort](../models/advisorreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the advisor call. | -| `maxTokens` | *number* | :heavy_minus_sign: | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file +| `effort` | [models.AdvisorReasoningEffort](../models/advisorreasoningeffort.mdx) | ➖ | Reasoning effort level for the advisor call. | +| `maxTokens` | *number* | ➖ | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file diff --git a/docs/models/advisorservertoolconfig.mdx b/docs/models/advisorservertoolconfig.mdx index ed2a1d093..95c4b1b6f 100644 --- a/docs/models/advisorservertoolconfig.mdx +++ b/docs/models/advisorservertoolconfig.mdx @@ -16,11 +16,11 @@ let value: AdvisorServerToolConfig = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `forwardTranscript` | *boolean* | :heavy_minus_sign: | When true, the full parent conversation is forwarded to the advisor so it sees the same context the executor does (and the tool-call `prompt`, if given, is appended as a final user turn). When false or omitted, the advisor receives only the `prompt` the executor passes in the tool call. | false | -| `instructions` | *string* | :heavy_minus_sign: | System instructions for the advisor sub-agent. When omitted, the advisor responds with no system prompt of its own. | You are a senior staff engineer. Give a focused, decisive plan. | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | -| `model` | *string* | :heavy_minus_sign: | Slug of the advisor model to consult (any OpenRouter model). When omitted, the executor can choose it via the tool call's `model` argument; if neither is set, the model from the outer API request is used. | ~anthropic/claude-opus-latest | -| `name` | *string* | :heavy_minus_sign: | Optional name for this advisor. The model sees one tool per named advisor (and one default for an unnamed entry). Names must be unique across advisor entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | reviewer | -| `reasoning` | [models.AdvisorReasoning](../models/advisorreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to the advisor call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "high"
} | -| `stream` | *boolean* | :heavy_minus_sign: | When true, the advisor's advice streams incrementally as it is produced. In the Responses API this emits `response.output_text.delta` events targeting the advisor output item; the final `advice` field is still set on the completed item. Has no effect on the Chat Completions API (where the advice arrives only as the final tool result). When false or omitted, the advice arrives only as the final result. | false | -| `temperature` | *number* | :heavy_minus_sign: | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file +| `forwardTranscript` | *boolean* | ➖ | When true, the full parent conversation is forwarded to the advisor so it sees the same context the executor does (and the tool-call `prompt`, if given, is appended as a final user turn). When false or omitted, the advisor receives only the `prompt` the executor passes in the tool call. | false | +| `instructions` | *string* | ➖ | System instructions for the advisor sub-agent. When omitted, the advisor responds with no system prompt of its own. | You are a senior staff engineer. Give a focused, decisive plan. | +| `maxCompletionTokens` | *number* | ➖ | Maximum number of output tokens (including reasoning) the advisor may produce. When omitted, the provider's default applies. | 2048 | +| `model` | *string* | ➖ | Slug of the advisor model to consult (any OpenRouter model). When omitted, the executor can choose it via the tool call's `model` argument; if neither is set, the model from the outer API request is used. | ~anthropic/claude-opus-latest | +| `name` | *string* | ➖ | Optional name for this advisor. The model sees one tool per named advisor (and one default for an unnamed entry). Names must be unique across advisor entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | reviewer | +| `reasoning` | [models.AdvisorReasoning](../models/advisorreasoning.mdx) | ➖ | Reasoning configuration forwarded to the advisor call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "high"
} | +| `stream` | *boolean* | ➖ | When true, the advisor's advice streams incrementally as it is produced. In the Responses API this emits `response.output_text.delta` events targeting the advisor output item; the final `advice` field is still set on the completed item. Has no effect on the Chat Completions API (where the advice arrives only as the final tool result). When false or omitted, the advice arrives only as the final result. | false | +| `temperature` | *number* | ➖ | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 | \ No newline at end of file diff --git a/docs/models/advisorservertoolopenrouter.mdx b/docs/models/advisorservertoolopenrouter.mdx index 6ee6b33bb..c7c23a143 100644 --- a/docs/models/advisorservertoolopenrouter.mdx +++ b/docs/models/advisorservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: AdvisorServerToolOpenRouter = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `parameters` | [models.AdvisorServerToolConfig](../models/advisorservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | -| `type` | [models.AdvisorServerToolOpenRouterType](../models/advisorservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.AdvisorServerToolConfig](../models/advisorservertoolconfig.mdx) | ➖ | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | +| `type` | [models.AdvisorServerToolOpenRouterType](../models/advisorservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/agent.mdx b/docs/models/agent.mdx index 24b89b723..26ca25c12 100644 --- a/docs/models/agent.mdx +++ b/docs/models/agent.mdx @@ -16,5 +16,5 @@ let value: Agent = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `agentName` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `agentName` | *string* | ✅ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/agentmessageitem.mdx b/docs/models/agentmessageitem.mdx index 1294e512c..545c090b7 100644 --- a/docs/models/agentmessageitem.mdx +++ b/docs/models/agentmessageitem.mdx @@ -26,10 +26,10 @@ let value: AgentMessageItem = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `agent` | [models.Agent](../models/agent.mdx) | :heavy_minus_sign: | N/A | | -| `author` | *string* | :heavy_check_mark: | N/A | | -| `content` | *models.AgentMessageItemContentUnion*[] | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `recipient` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.TypeAgentMessage](../models/typeagentmessage.mdx) | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"author": "/root/worker",
"content": [
\{
"text": "Task complete.",
"type": "input_text"
}
],
"recipient": "/root",
"type": "agent_message"
} | \ No newline at end of file +| `agent` | [models.Agent](../models/agent.mdx) | ➖ | N/A | | +| `author` | *string* | ✅ | N/A | | +| `content` | *models.AgentMessageItemContentUnion*[] | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `recipient` | *string* | ✅ | N/A | | +| `type` | [models.TypeAgentMessage](../models/typeagentmessage.mdx) | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"author": "/root/worker",
"content": [
\{
"text": "Task complete.",
"type": "input_text"
}
],
"recipient": "/root",
"type": "agent_message"
} | \ No newline at end of file diff --git a/docs/models/agentmessageitemcontentinputimage.mdx b/docs/models/agentmessageitemcontentinputimage.mdx index da2fa409a..4d768ab57 100644 --- a/docs/models/agentmessageitemcontentinputimage.mdx +++ b/docs/models/agentmessageitemcontentinputimage.mdx @@ -19,7 +19,7 @@ let value: AgentMessageItemContentInputImage = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `detail` | [models.AgentMessageItemDetail](../models/agentmessageitemdetail.mdx) | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [models.AgentMessageItemDetail](../models/agentmessageitemdetail.mdx) | ✅ | N/A | +| `fileId` | *string* | ➖ | N/A | +| `imageUrl` | *string* | ➖ | N/A | +| `type` | *"input_image"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/alignment.mdx b/docs/models/alignment.mdx index 7fb4172cf..5026f0b2c 100644 --- a/docs/models/alignment.mdx +++ b/docs/models/alignment.mdx @@ -29,4 +29,4 @@ let value: Alignment = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `calls` | *models.AlignmentCallRecord*[] | :heavy_check_mark: | One record per evaluated assistant message of the request, in the order the messages were produced. | \ No newline at end of file +| `calls` | *models.AlignmentCallRecord*[] | ✅ | One record per evaluated assistant message of the request, in the order the messages were produced. | \ No newline at end of file diff --git a/docs/models/alignmentallowedcallrecord.mdx b/docs/models/alignmentallowedcallrecord.mdx index 98e37710f..f85634998 100644 --- a/docs/models/alignmentallowedcallrecord.mdx +++ b/docs/models/alignmentallowedcallrecord.mdx @@ -23,6 +23,6 @@ let value: AlignmentAllowedCallRecord = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call` | *number* | :heavy_check_mark: | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | -| `outcome` | *"allowed"* | :heavy_check_mark: | N/A | -| `rules` | [models.AlignmentRuleRecord](../models/alignmentrulerecord.mdx)[] | :heavy_check_mark: | One record per rule, in the order of `rules` in the request. | \ No newline at end of file +| `call` | *number* | ✅ | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | +| `outcome` | *"allowed"* | ✅ | N/A | +| `rules` | [models.AlignmentRuleRecord](../models/alignmentrulerecord.mdx)[] | ✅ | One record per rule, in the order of `rules` in the request. | \ No newline at end of file diff --git a/docs/models/alignmentblockedcallrecord.mdx b/docs/models/alignmentblockedcallrecord.mdx index d6256276f..f91862524 100644 --- a/docs/models/alignmentblockedcallrecord.mdx +++ b/docs/models/alignmentblockedcallrecord.mdx @@ -18,6 +18,6 @@ let value: AlignmentBlockedCallRecord = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call` | *number* | :heavy_check_mark: | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | -| `outcome` | *"blocked"* | :heavy_check_mark: | N/A | -| `rules` | [models.AlignmentRuleRecord](../models/alignmentrulerecord.mdx)[] | :heavy_check_mark: | One record per rule, in the order of `rules` in the request. | \ No newline at end of file +| `call` | *number* | ✅ | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | +| `outcome` | *"blocked"* | ✅ | N/A | +| `rules` | [models.AlignmentRuleRecord](../models/alignmentrulerecord.mdx)[] | ✅ | One record per rule, in the order of `rules` in the request. | \ No newline at end of file diff --git a/docs/models/alignmentchataudio.mdx b/docs/models/alignmentchataudio.mdx index ca99551e2..f8226166e 100644 --- a/docs/models/alignmentchataudio.mdx +++ b/docs/models/alignmentchataudio.mdx @@ -18,5 +18,5 @@ let value: AlignmentChatAudio = { | Field | Type | Required | Description | | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `id` | *string* | :heavy_minus_sign: | The provider id of the audio. | -| `transcript` | *string* | :heavy_check_mark: | The transcript of the audio. | \ No newline at end of file +| `id` | *string* | ➖ | The provider id of the audio. | +| `transcript` | *string* | ✅ | The transcript of the audio. | \ No newline at end of file diff --git a/docs/models/alignmentchatimage.mdx b/docs/models/alignmentchatimage.mdx index 992629c98..3608463b8 100644 --- a/docs/models/alignmentchatimage.mdx +++ b/docs/models/alignmentchatimage.mdx @@ -19,5 +19,5 @@ let value: AlignmentChatImage = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `imageUrl` | [models.AlignmentChatImageImageUrl](../models/alignmentchatimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.AlignmentChatImageType](../models/alignmentchatimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [models.AlignmentChatImageImageUrl](../models/alignmentchatimageimageurl.mdx) | ✅ | N/A | +| `type` | [models.AlignmentChatImageType](../models/alignmentchatimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/alignmentchatimageimageurl.mdx b/docs/models/alignmentchatimageimageurl.mdx index 52348a9e6..eacf27715 100644 --- a/docs/models/alignmentchatimageimageurl.mdx +++ b/docs/models/alignmentchatimageimageurl.mdx @@ -16,4 +16,4 @@ let value: AlignmentChatImageImageUrl = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/alignmentchatrejected.mdx b/docs/models/alignmentchatrejected.mdx index 0140ba983..99b89e025 100644 --- a/docs/models/alignmentchatrejected.mdx +++ b/docs/models/alignmentchatrejected.mdx @@ -20,9 +20,9 @@ let value: AlignmentChatRejected = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `audio` | [models.AlignmentChatAudio](../models/alignmentchataudio.mdx) | :heavy_minus_sign: | The audio of the withheld message: its `id` and `transcript`. The plugin does not retain `data` or `expires_at`. | \{
"id": "audio_abc123",
"transcript": "Sure, I can take 20% off your order."
} | -| `content` | *string* | :heavy_check_mark: | N/A | | -| `images` | [models.AlignmentChatImage](../models/alignmentchatimage.mdx)[] | :heavy_minus_sign: | N/A | | -| `refusal` | *string* | :heavy_check_mark: | N/A | | -| `role` | [models.AlignmentChatRejectedRole](../models/alignmentchatrejectedrole.mdx) | :heavy_check_mark: | N/A | | -| `toolCalls` | [models.AlignmentChatToolCall](../models/alignmentchattoolcall.mdx)[] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `audio` | [models.AlignmentChatAudio](../models/alignmentchataudio.mdx) | ➖ | The audio of the withheld message: its `id` and `transcript`. The plugin does not retain `data` or `expires_at`. | \{
"id": "audio_abc123",
"transcript": "Sure, I can take 20% off your order."
} | +| `content` | *string* | ✅ | N/A | | +| `images` | [models.AlignmentChatImage](../models/alignmentchatimage.mdx)[] | ➖ | N/A | | +| `refusal` | *string* | ✅ | N/A | | +| `role` | [models.AlignmentChatRejectedRole](../models/alignmentchatrejectedrole.mdx) | ✅ | N/A | | +| `toolCalls` | [models.AlignmentChatToolCall](../models/alignmentchattoolcall.mdx)[] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/alignmentchattoolcall.mdx b/docs/models/alignmentchattoolcall.mdx index e4c15bc24..4d47dc904 100644 --- a/docs/models/alignmentchattoolcall.mdx +++ b/docs/models/alignmentchattoolcall.mdx @@ -21,6 +21,6 @@ let value: AlignmentChatToolCall = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `function` | [models.AlignmentChatToolCallFunction](../models/alignmentchattoolcallfunction.mdx) | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AlignmentChatToolCallType](../models/alignmentchattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `function` | [models.AlignmentChatToolCallFunction](../models/alignmentchattoolcallfunction.mdx) | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `type` | [models.AlignmentChatToolCallType](../models/alignmentchattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/alignmentchattoolcallfunction.mdx b/docs/models/alignmentchattoolcallfunction.mdx index cdf910696..6d72ef657 100644 --- a/docs/models/alignmentchattoolcallfunction.mdx +++ b/docs/models/alignmentchattoolcallfunction.mdx @@ -17,5 +17,5 @@ let value: AlignmentChatToolCallFunction = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | +| `name` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/alignmentplugin.mdx b/docs/models/alignmentplugin.mdx index 76817c813..d644b5c1a 100644 --- a/docs/models/alignmentplugin.mdx +++ b/docs/models/alignmentplugin.mdx @@ -21,9 +21,9 @@ let value: AlignmentPlugin = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *"alignment"* | :heavy_check_mark: | N/A | | -| `instruct` | *boolean* | :heavy_minus_sign: | Whether the rules are stated to the model in a system message on every provider call. Default true. | | -| `maxRetries` | *number* | :heavy_minus_sign: | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | -| `mode` | [models.AlignmentPluginMode](../models/alignmentpluginmode.mdx) | :heavy_minus_sign: | `enforce`: a turn that breaks a rule is withheld, retried, and finally returned as an error. `audit`: every turn is evaluated and returned. Default `enforce`. | | -| `rules` | *string*[] | :heavy_check_mark: | Texts that state what the reply must do or must not do. Each rule is evaluated on its own. | [
"Never offer a discount.",
"End with exactly one question."
] | -| `threshold` | *number* | :heavy_minus_sign: | Probability at or above which a rule is broken. Default 0.7. | | \ No newline at end of file +| `id` | *"alignment"* | ✅ | N/A | | +| `instruct` | *boolean* | ➖ | Whether the rules are stated to the model in a system message on every provider call. Default true. | | +| `maxRetries` | *number* | ➖ | Provider calls made again after a blocked turn, in enforce mode. Default 1. | | +| `mode` | [models.AlignmentPluginMode](../models/alignmentpluginmode.mdx) | ➖ | `enforce`: a turn that breaks a rule is withheld, retried, and finally returned as an error. `audit`: every turn is evaluated and returned. Default `enforce`. | | +| `rules` | *string*[] | ✅ | Texts that state what the reply must do or must not do. Each rule is evaluated on its own. | [
"Never offer a discount.",
"End with exactly one question."
] | +| `threshold` | *number* | ➖ | Probability at or above which a rule is broken. Default 0.7. | | \ No newline at end of file diff --git a/docs/models/alignmentrulerecord.mdx b/docs/models/alignmentrulerecord.mdx index cbeb0cc7f..1c76b7741 100644 --- a/docs/models/alignmentrulerecord.mdx +++ b/docs/models/alignmentrulerecord.mdx @@ -17,5 +17,5 @@ let value: AlignmentRuleRecord = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `broken` | *boolean* | :heavy_check_mark: | Whether probability is at or above the threshold. | -| `probability` | *number* | :heavy_check_mark: | The evaluator's probability that the turn breaks the rule. | \ No newline at end of file +| `broken` | *boolean* | ✅ | Whether probability is at or above the threshold. | +| `probability` | *number* | ✅ | The evaluator's probability that the turn breaks the rule. | \ No newline at end of file diff --git a/docs/models/alignmentunavailablecallrecord.mdx b/docs/models/alignmentunavailablecallrecord.mdx index b06f8c571..9528997e5 100644 --- a/docs/models/alignmentunavailablecallrecord.mdx +++ b/docs/models/alignmentunavailablecallrecord.mdx @@ -18,6 +18,6 @@ let value: AlignmentUnavailableCallRecord = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `call` | *number* | :heavy_check_mark: | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | -| `outcome` | *"unavailable"* | :heavy_check_mark: | N/A | -| `reason` | [models.AlignmentUnavailableCallRecordReason](../models/alignmentunavailablecallrecordreason.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `call` | *number* | ✅ | Number of the record, from 1. A record is one evaluated assistant message; a model call of a server-tool loop that produces several messages has one record per message, and a retry continues the numbering. | +| `outcome` | *"unavailable"* | ✅ | N/A | +| `reason` | [models.AlignmentUnavailableCallRecordReason](../models/alignmentunavailablecallrecordreason.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/allowedtools.mdx b/docs/models/allowedtools.mdx index ac30586a5..4635bc1bb 100644 --- a/docs/models/allowedtools.mdx +++ b/docs/models/allowedtools.mdx @@ -14,5 +14,5 @@ let value: AllowedTools = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `readOnly` | *boolean* | :heavy_minus_sign: | N/A | -| `toolNames` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `readOnly` | *boolean* | ➖ | N/A | +| `toolNames` | *string*[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/always.mdx b/docs/models/always.mdx index 218b416be..2ec82cb40 100644 --- a/docs/models/always.mdx +++ b/docs/models/always.mdx @@ -14,4 +14,4 @@ let value: Always = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `toolNames` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `toolNames` | *string*[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/annotationaddedevent.mdx b/docs/models/annotationaddedevent.mdx index 81eeb238d..4253197d9 100644 --- a/docs/models/annotationaddedevent.mdx +++ b/docs/models/annotationaddedevent.mdx @@ -29,10 +29,10 @@ let value: AnnotationAddedEvent = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `annotation` | *models.OpenAIResponsesAnnotation* | :heavy_check_mark: | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | -| `annotationIndex` | *number* | :heavy_check_mark: | N/A | | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | | -| `itemId` | *string* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.output_text.annotation.added"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `annotation` | *models.OpenAIResponsesAnnotation* | ✅ | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | +| `annotationIndex` | *number* | ✅ | N/A | | +| `contentIndex` | *number* | ✅ | N/A | | +| `itemId` | *string* | ✅ | N/A | | +| `outputIndex` | *number* | ✅ | N/A | | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `type` | *"response.output_text.annotation.added"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/annotationfile.mdx b/docs/models/annotationfile.mdx index 58791a4d0..190cebecf 100644 --- a/docs/models/annotationfile.mdx +++ b/docs/models/annotationfile.mdx @@ -20,5 +20,5 @@ let value: AnnotationFile = { | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `file` | [models.BatchObjectFile](../models/batchobjectfile.mdx) | :heavy_check_mark: | N/A | -| `type` | *"file"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `file` | [models.BatchObjectFile](../models/batchobjectfile.mdx) | ✅ | N/A | +| `type` | *"file"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/annotationurlcitation.mdx b/docs/models/annotationurlcitation.mdx index de1d1ad0a..526f4eb4c 100644 --- a/docs/models/annotationurlcitation.mdx +++ b/docs/models/annotationurlcitation.mdx @@ -22,5 +22,5 @@ let value: AnnotationURLCitation = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `type` | *"url_citation"* | :heavy_check_mark: | N/A | -| `urlCitation` | [models.BatchObjectUrlCitation](../models/batchobjecturlcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"url_citation"* | ✅ | N/A | +| `urlCitation` | [models.BatchObjectUrlCitation](../models/batchobjecturlcitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/annotationwebsearchcitation.mdx b/docs/models/annotationwebsearchcitation.mdx index 48dbf9fdf..d6e932b41 100644 --- a/docs/models/annotationwebsearchcitation.mdx +++ b/docs/models/annotationwebsearchcitation.mdx @@ -20,5 +20,5 @@ let value: AnnotationWebSearchCitation = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `type` | *"web_search_citation"* | :heavy_check_mark: | N/A | -| `webSearchCitation` | [models.WebSearchCitation](../models/websearchcitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"web_search_citation"* | ✅ | N/A | +| `webSearchCitation` | [models.WebSearchCitation](../models/websearchcitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicadvisormessageusageiteration.mdx b/docs/models/anthropicadvisormessageusageiteration.mdx index c9e87a21a..d303d9f40 100644 --- a/docs/models/anthropicadvisormessageusageiteration.mdx +++ b/docs/models/anthropicadvisormessageusageiteration.mdx @@ -17,10 +17,10 @@ let value: AnthropicAdvisorMessageUsageIteration = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cacheCreationInputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `cacheReadInputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `inputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `outputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.AnthropicAdvisorMessageUsageIterationType](../models/anthropicadvisormessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cacheCreationInputTokens` | *number* | ➖ | N/A | | +| `cacheReadInputTokens` | *number* | ➖ | N/A | | +| `inputTokens` | *number* | ➖ | N/A | | +| `outputTokens` | *number* | ➖ | N/A | | +| `model` | *string* | ✅ | N/A | | +| `type` | [models.AnthropicAdvisorMessageUsageIterationType](../models/anthropicadvisormessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicadvisortoolresult.mdx b/docs/models/anthropicadvisortoolresult.mdx index 6bee1d1cb..3b52e63ff 100644 --- a/docs/models/anthropicadvisortoolresult.mdx +++ b/docs/models/anthropicadvisortoolresult.mdx @@ -20,6 +20,6 @@ let value: AnthropicAdvisorToolResult = { | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `content` | Record\ | :heavy_check_mark: | N/A | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"advisor_tool_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | Record\ | ✅ | N/A | +| `toolUseId` | *string* | ✅ | N/A | +| `type` | *"advisor_tool_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicbase64imagesource.mdx b/docs/models/anthropicbase64imagesource.mdx index ed374bf24..2e9e7672c 100644 --- a/docs/models/anthropicbase64imagesource.mdx +++ b/docs/models/anthropicbase64imagesource.mdx @@ -18,6 +18,6 @@ let value: AnthropicBase64ImageSource = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | *string* | :heavy_check_mark: | N/A | | -| `mediaType` | [models.AnthropicImageMimeType](../models/anthropicimagemimetype.mdx) | :heavy_check_mark: | N/A | image/jpeg | -| `type` | *"base64"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `data` | *string* | ✅ | N/A | | +| `mediaType` | [models.AnthropicImageMimeType](../models/anthropicimagemimetype.mdx) | ✅ | N/A | image/jpeg | +| `type` | *"base64"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicbase64pdfsource.mdx b/docs/models/anthropicbase64pdfsource.mdx index 2a3716ba8..73967af6e 100644 --- a/docs/models/anthropicbase64pdfsource.mdx +++ b/docs/models/anthropicbase64pdfsource.mdx @@ -18,6 +18,6 @@ let value: AnthropicBase64PdfSource = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | -| `mediaType` | [models.AnthropicBase64PdfSourceMediaType](../models/anthropicbase64pdfsourcemediatype.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicBase64PdfSourceType](../models/anthropicbase64pdfsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *string* | ✅ | N/A | +| `mediaType` | [models.AnthropicBase64PdfSourceMediaType](../models/anthropicbase64pdfsourcemediatype.mdx) | ✅ | N/A | +| `type` | [models.AnthropicBase64PdfSourceType](../models/anthropicbase64pdfsourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicbashcodeexecutionoutput.mdx b/docs/models/anthropicbashcodeexecutionoutput.mdx index c9bbfbec2..632d7eef8 100644 --- a/docs/models/anthropicbashcodeexecutionoutput.mdx +++ b/docs/models/anthropicbashcodeexecutionoutput.mdx @@ -17,5 +17,5 @@ let value: AnthropicBashCodeExecutionOutput = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicBashCodeExecutionOutputType](../models/anthropicbashcodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileId` | *string* | ✅ | N/A | +| `type` | [models.AnthropicBashCodeExecutionOutputType](../models/anthropicbashcodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicbashcodeexecutionresult.mdx b/docs/models/anthropicbashcodeexecutionresult.mdx index 027d6b3ec..a1785d174 100644 --- a/docs/models/anthropicbashcodeexecutionresult.mdx +++ b/docs/models/anthropicbashcodeexecutionresult.mdx @@ -20,8 +20,8 @@ let value: AnthropicBashCodeExecutionResult = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `content` | [models.AnthropicBashCodeExecutionOutput](../models/anthropicbashcodeexecutionoutput.mdx)[] | :heavy_check_mark: | N/A | -| `returnCode` | *number* | :heavy_check_mark: | N/A | -| `stderr` | *string* | :heavy_check_mark: | N/A | -| `stdout` | *string* | :heavy_check_mark: | N/A | -| `type` | *"bash_code_execution_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | [models.AnthropicBashCodeExecutionOutput](../models/anthropicbashcodeexecutionoutput.mdx)[] | ✅ | N/A | +| `returnCode` | *number* | ✅ | N/A | +| `stderr` | *string* | ✅ | N/A | +| `stdout` | *string* | ✅ | N/A | +| `type` | *"bash_code_execution_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicbashcodeexecutiontoolresult.mdx b/docs/models/anthropicbashcodeexecutiontoolresult.mdx index 451d63464..af89cdbff 100644 --- a/docs/models/anthropicbashcodeexecutiontoolresult.mdx +++ b/docs/models/anthropicbashcodeexecutiontoolresult.mdx @@ -24,6 +24,6 @@ let value: AnthropicBashCodeExecutionToolResult = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `content` | *models.AnthropicBashCodeExecutionContent* | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"bash_code_execution_tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | *models.AnthropicBashCodeExecutionContent* | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "bash_code_execution_result"
} | +| `toolUseId` | *string* | ✅ | N/A | | +| `type` | *"bash_code_execution_tool_result"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicbashcodeexecutiontoolresulterror.mdx b/docs/models/anthropicbashcodeexecutiontoolresulterror.mdx index 460cd8e08..1f3025e1c 100644 --- a/docs/models/anthropicbashcodeexecutiontoolresulterror.mdx +++ b/docs/models/anthropicbashcodeexecutiontoolresulterror.mdx @@ -17,5 +17,5 @@ let value: AnthropicBashCodeExecutionToolResultError = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `errorCode` | [models.AnthropicBashCodeExecutionToolResultErrorErrorCode](../models/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `type` | *"bash_code_execution_tool_result_error"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `errorCode` | [models.AnthropicBashCodeExecutionToolResultErrorErrorCode](../models/anthropicbashcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `type` | *"bash_code_execution_tool_result_error"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccachecontroldirective.mdx b/docs/models/anthropiccachecontroldirective.mdx index c43209582..ad34fc5fa 100644 --- a/docs/models/anthropiccachecontroldirective.mdx +++ b/docs/models/anthropiccachecontroldirective.mdx @@ -18,5 +18,5 @@ let value: AnthropicCacheControlDirective = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ttl` | [models.AnthropicCacheControlTtl](../models/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `type` | [models.AnthropicCacheControlDirectiveType](../models/anthropiccachecontroldirectivetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ttl` | [models.AnthropicCacheControlTtl](../models/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | +| `type` | [models.AnthropicCacheControlDirectiveType](../models/anthropiccachecontroldirectivetype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropiccachecreation.mdx b/docs/models/anthropiccachecreation.mdx index fff3213d0..620074606 100644 --- a/docs/models/anthropiccachecreation.mdx +++ b/docs/models/anthropiccachecreation.mdx @@ -17,5 +17,5 @@ let value: AnthropicCacheCreation = { | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `ephemeral1hInputTokens` | *number* | :heavy_check_mark: | N/A | -| `ephemeral5mInputTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `ephemeral1hInputTokens` | *number* | ✅ | N/A | +| `ephemeral5mInputTokens` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationcharlocation.mdx b/docs/models/anthropiccitationcharlocation.mdx index 8627c012e..ed358084b 100644 --- a/docs/models/anthropiccitationcharlocation.mdx +++ b/docs/models/anthropiccitationcharlocation.mdx @@ -22,10 +22,10 @@ let value: AnthropicCitationCharLocation = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `documentIndex` | *number* | :heavy_check_mark: | N/A | -| `documentTitle` | *string* | :heavy_check_mark: | N/A | -| `endCharIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `startCharIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | *"char_location"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `documentIndex` | *number* | ✅ | N/A | +| `documentTitle` | *string* | ✅ | N/A | +| `endCharIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `startCharIndex` | *number* | ✅ | N/A | +| `type` | *"char_location"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationcharlocationparam.mdx b/docs/models/anthropiccitationcharlocationparam.mdx index 47e6bbb65..39b8a0594 100644 --- a/docs/models/anthropiccitationcharlocationparam.mdx +++ b/docs/models/anthropiccitationcharlocationparam.mdx @@ -21,9 +21,9 @@ let value: AnthropicCitationCharLocationParam = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `documentIndex` | *number* | :heavy_check_mark: | N/A | -| `documentTitle` | *string* | :heavy_check_mark: | N/A | -| `endCharIndex` | *number* | :heavy_check_mark: | N/A | -| `startCharIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | *"char_location"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `documentIndex` | *number* | ✅ | N/A | +| `documentTitle` | *string* | ✅ | N/A | +| `endCharIndex` | *number* | ✅ | N/A | +| `startCharIndex` | *number* | ✅ | N/A | +| `type` | *"char_location"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationcontentblocklocation.mdx b/docs/models/anthropiccitationcontentblocklocation.mdx index 979cc8f45..626c92031 100644 --- a/docs/models/anthropiccitationcontentblocklocation.mdx +++ b/docs/models/anthropiccitationcontentblocklocation.mdx @@ -22,10 +22,10 @@ let value: AnthropicCitationContentBlockLocation = { | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `documentIndex` | *number* | :heavy_check_mark: | N/A | -| `documentTitle` | *string* | :heavy_check_mark: | N/A | -| `endBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `startBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | *"content_block_location"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `documentIndex` | *number* | ✅ | N/A | +| `documentTitle` | *string* | ✅ | N/A | +| `endBlockIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `startBlockIndex` | *number* | ✅ | N/A | +| `type` | *"content_block_location"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationcontentblocklocationparam.mdx b/docs/models/anthropiccitationcontentblocklocationparam.mdx index c1f26928c..b84196bb0 100644 --- a/docs/models/anthropiccitationcontentblocklocationparam.mdx +++ b/docs/models/anthropiccitationcontentblocklocationparam.mdx @@ -21,9 +21,9 @@ let value: AnthropicCitationContentBlockLocationParam = { | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `documentIndex` | *number* | :heavy_check_mark: | N/A | -| `documentTitle` | *string* | :heavy_check_mark: | N/A | -| `endBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `startBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | *"content_block_location"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `documentIndex` | *number* | ✅ | N/A | +| `documentTitle` | *string* | ✅ | N/A | +| `endBlockIndex` | *number* | ✅ | N/A | +| `startBlockIndex` | *number* | ✅ | N/A | +| `type` | *"content_block_location"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationpagelocation.mdx b/docs/models/anthropiccitationpagelocation.mdx index 33e9c4e71..c417cd734 100644 --- a/docs/models/anthropiccitationpagelocation.mdx +++ b/docs/models/anthropiccitationpagelocation.mdx @@ -22,10 +22,10 @@ let value: AnthropicCitationPageLocation = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `documentIndex` | *number* | :heavy_check_mark: | N/A | -| `documentTitle` | *string* | :heavy_check_mark: | N/A | -| `endPageNumber` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `startPageNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"page_location"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `documentIndex` | *number* | ✅ | N/A | +| `documentTitle` | *string* | ✅ | N/A | +| `endPageNumber` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `startPageNumber` | *number* | ✅ | N/A | +| `type` | *"page_location"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationpagelocationparam.mdx b/docs/models/anthropiccitationpagelocationparam.mdx index 2fc698d2d..f23492f94 100644 --- a/docs/models/anthropiccitationpagelocationparam.mdx +++ b/docs/models/anthropiccitationpagelocationparam.mdx @@ -21,9 +21,9 @@ let value: AnthropicCitationPageLocationParam = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `documentIndex` | *number* | :heavy_check_mark: | N/A | -| `documentTitle` | *string* | :heavy_check_mark: | N/A | -| `endPageNumber` | *number* | :heavy_check_mark: | N/A | -| `startPageNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"page_location"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `documentIndex` | *number* | ✅ | N/A | +| `documentTitle` | *string* | ✅ | N/A | +| `endPageNumber` | *number* | ✅ | N/A | +| `startPageNumber` | *number* | ✅ | N/A | +| `type` | *"page_location"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationsconfig.mdx b/docs/models/anthropiccitationsconfig.mdx index 8137478b7..1c1023f42 100644 --- a/docs/models/anthropiccitationsconfig.mdx +++ b/docs/models/anthropiccitationsconfig.mdx @@ -16,4 +16,4 @@ let value: AnthropicCitationsConfig = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| `enabled` | *boolean* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationsearchresultlocation.mdx b/docs/models/anthropiccitationsearchresultlocation.mdx index acfe44599..1451cc793 100644 --- a/docs/models/anthropiccitationsearchresultlocation.mdx +++ b/docs/models/anthropiccitationsearchresultlocation.mdx @@ -22,10 +22,10 @@ let value: AnthropicCitationSearchResultLocation = { | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `endBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `searchResultIndex` | *number* | :heavy_check_mark: | N/A | -| `source` | *string* | :heavy_check_mark: | N/A | -| `startBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *"search_result_location"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `endBlockIndex` | *number* | ✅ | N/A | +| `searchResultIndex` | *number* | ✅ | N/A | +| `source` | *string* | ✅ | N/A | +| `startBlockIndex` | *number* | ✅ | N/A | +| `title` | *string* | ✅ | N/A | +| `type` | *"search_result_location"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationsearchresultlocationparam.mdx b/docs/models/anthropiccitationsearchresultlocationparam.mdx index ac5d6853a..4165e99e9 100644 --- a/docs/models/anthropiccitationsearchresultlocationparam.mdx +++ b/docs/models/anthropiccitationsearchresultlocationparam.mdx @@ -22,10 +22,10 @@ let value: AnthropicCitationSearchResultLocationParam = { | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `endBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `searchResultIndex` | *number* | :heavy_check_mark: | N/A | -| `source` | *string* | :heavy_check_mark: | N/A | -| `startBlockIndex` | *number* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *"search_result_location"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `endBlockIndex` | *number* | ✅ | N/A | +| `searchResultIndex` | *number* | ✅ | N/A | +| `source` | *string* | ✅ | N/A | +| `startBlockIndex` | *number* | ✅ | N/A | +| `title` | *string* | ✅ | N/A | +| `type` | *"search_result_location"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationwebsearchresultlocation.mdx b/docs/models/anthropiccitationwebsearchresultlocation.mdx index 33c1992f9..a7e776d2a 100644 --- a/docs/models/anthropiccitationwebsearchresultlocation.mdx +++ b/docs/models/anthropiccitationwebsearchresultlocation.mdx @@ -20,8 +20,8 @@ let value: AnthropicCitationWebSearchResultLocation = { | Field | Type | Required | Description | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `encryptedIndex` | *string* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *"web_search_result_location"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `encryptedIndex` | *string* | ✅ | N/A | +| `title` | *string* | ✅ | N/A | +| `type` | *"web_search_result_location"* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccitationwebsearchresultlocationparam.mdx b/docs/models/anthropiccitationwebsearchresultlocationparam.mdx index 6cc7b9677..ac87599c6 100644 --- a/docs/models/anthropiccitationwebsearchresultlocationparam.mdx +++ b/docs/models/anthropiccitationwebsearchresultlocationparam.mdx @@ -20,8 +20,8 @@ let value: AnthropicCitationWebSearchResultLocationParam = { | Field | Type | Required | Description | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `citedText` | *string* | :heavy_check_mark: | N/A | -| `encryptedIndex` | *string* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *"web_search_result_location"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ✅ | N/A | +| `encryptedIndex` | *string* | ✅ | N/A | +| `title` | *string* | ✅ | N/A | +| `type` | *"web_search_result_location"* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccodeexecution20250825caller.mdx b/docs/models/anthropiccodeexecution20250825caller.mdx index b24a19735..348d0f184 100644 --- a/docs/models/anthropiccodeexecution20250825caller.mdx +++ b/docs/models/anthropiccodeexecution20250825caller.mdx @@ -17,5 +17,5 @@ let value: AnthropicCodeExecution20250825Caller = { | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `toolId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"code_execution_20250825"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `toolId` | *string* | ✅ | N/A | +| `type` | *"code_execution_20250825"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccodeexecution20260120caller.mdx b/docs/models/anthropiccodeexecution20260120caller.mdx index e99ae9e74..62ece57c9 100644 --- a/docs/models/anthropiccodeexecution20260120caller.mdx +++ b/docs/models/anthropiccodeexecution20260120caller.mdx @@ -17,5 +17,5 @@ let value: AnthropicCodeExecution20260120Caller = { | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `toolId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"code_execution_20260120"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `toolId` | *string* | ✅ | N/A | +| `type` | *"code_execution_20260120"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccodeexecutionoutput.mdx b/docs/models/anthropiccodeexecutionoutput.mdx index a23674e05..933a0121a 100644 --- a/docs/models/anthropiccodeexecutionoutput.mdx +++ b/docs/models/anthropiccodeexecutionoutput.mdx @@ -17,5 +17,5 @@ let value: AnthropicCodeExecutionOutput = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicCodeExecutionOutputType](../models/anthropiccodeexecutionoutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileId` | *string* | ✅ | N/A | +| `type` | [models.AnthropicCodeExecutionOutputType](../models/anthropiccodeexecutionoutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccodeexecutionresult.mdx b/docs/models/anthropiccodeexecutionresult.mdx index 1c8bf52c5..9a16ab2d9 100644 --- a/docs/models/anthropiccodeexecutionresult.mdx +++ b/docs/models/anthropiccodeexecutionresult.mdx @@ -20,8 +20,8 @@ let value: AnthropicCodeExecutionResult = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `content` | [models.AnthropicCodeExecutionOutput](../models/anthropiccodeexecutionoutput.mdx)[] | :heavy_check_mark: | N/A | -| `returnCode` | *number* | :heavy_check_mark: | N/A | -| `stderr` | *string* | :heavy_check_mark: | N/A | -| `stdout` | *string* | :heavy_check_mark: | N/A | -| `type` | *"code_execution_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | [models.AnthropicCodeExecutionOutput](../models/anthropiccodeexecutionoutput.mdx)[] | ✅ | N/A | +| `returnCode` | *number* | ✅ | N/A | +| `stderr` | *string* | ✅ | N/A | +| `stdout` | *string* | ✅ | N/A | +| `type` | *"code_execution_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccodeexecutiontoolresult.mdx b/docs/models/anthropiccodeexecutiontoolresult.mdx index 901a84cf3..90f70711c 100644 --- a/docs/models/anthropiccodeexecutiontoolresult.mdx +++ b/docs/models/anthropiccodeexecutiontoolresult.mdx @@ -24,6 +24,6 @@ let value: AnthropicCodeExecutionToolResult = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `content` | *models.AnthropicCodeExecutionContent* | :heavy_check_mark: | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"code_execution_tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | *models.AnthropicCodeExecutionContent* | ✅ | N/A | \{
"content": [],
"return_code": 0,
"stderr": "",
"stdout": "Hello",
"type": "code_execution_result"
} | +| `toolUseId` | *string* | ✅ | N/A | | +| `type` | *"code_execution_tool_result"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropiccodeexecutiontoolresulterror.mdx b/docs/models/anthropiccodeexecutiontoolresulterror.mdx index 4183e0113..301c1f032 100644 --- a/docs/models/anthropiccodeexecutiontoolresulterror.mdx +++ b/docs/models/anthropiccodeexecutiontoolresulterror.mdx @@ -17,5 +17,5 @@ let value: AnthropicCodeExecutionToolResultError = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `errorCode` | [models.AnthropicServerToolErrorCode](../models/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | -| `type` | *"code_execution_tool_result_error"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `errorCode` | [models.AnthropicServerToolErrorCode](../models/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | +| `type` | *"code_execution_tool_result_error"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropiccompactionblock.mdx b/docs/models/anthropiccompactionblock.mdx index c609e97d5..1bf68cd7c 100644 --- a/docs/models/anthropiccompactionblock.mdx +++ b/docs/models/anthropiccompactionblock.mdx @@ -17,6 +17,6 @@ let value: AnthropicCompactionBlock = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `content` | *string* | :heavy_check_mark: | N/A | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"compaction"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *string* | ✅ | N/A | +| `encryptedContent` | *string* | ➖ | N/A | +| `type` | *"compaction"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccompactionusageiteration.mdx b/docs/models/anthropiccompactionusageiteration.mdx index a9e70b14d..624460b15 100644 --- a/docs/models/anthropiccompactionusageiteration.mdx +++ b/docs/models/anthropiccompactionusageiteration.mdx @@ -16,9 +16,9 @@ let value: AnthropicCompactionUsageIteration = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cacheCreationInputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `cacheReadInputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `inputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `outputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `type` | [models.AnthropicCompactionUsageIterationType](../models/anthropiccompactionusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cacheCreationInputTokens` | *number* | ➖ | N/A | | +| `cacheReadInputTokens` | *number* | ➖ | N/A | | +| `inputTokens` | *number* | ➖ | N/A | | +| `outputTokens` | *number* | ➖ | N/A | | +| `type` | [models.AnthropicCompactionUsageIterationType](../models/anthropiccompactionusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropiccontainer.mdx b/docs/models/anthropiccontainer.mdx index 694abc320..249b0ab3c 100644 --- a/docs/models/anthropiccontainer.mdx +++ b/docs/models/anthropiccontainer.mdx @@ -17,6 +17,6 @@ let value: AnthropicContainer = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `expiresAt` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `skills` | [models.AnthropicContainerSkill](../models/anthropiccontainerskill.mdx)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `expiresAt` | *string* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `skills` | [models.AnthropicContainerSkill](../models/anthropiccontainerskill.mdx)[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccontainerskill.mdx b/docs/models/anthropiccontainerskill.mdx index 9ae6d9117..d536c4e6c 100644 --- a/docs/models/anthropiccontainerskill.mdx +++ b/docs/models/anthropiccontainerskill.mdx @@ -18,6 +18,6 @@ let value: AnthropicContainerSkill = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `skillId` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicContainerSkillType](../models/anthropiccontainerskilltype.mdx) | :heavy_check_mark: | N/A | -| `version` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `skillId` | *string* | ✅ | N/A | +| `type` | [models.AnthropicContainerSkillType](../models/anthropiccontainerskilltype.mdx) | ✅ | N/A | +| `version` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropiccontainerupload.mdx b/docs/models/anthropiccontainerupload.mdx index 556ea75c1..50e6a2011 100644 --- a/docs/models/anthropiccontainerupload.mdx +++ b/docs/models/anthropiccontainerupload.mdx @@ -17,5 +17,5 @@ let value: AnthropicContainerUpload = { | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"container_upload"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileId` | *string* | ✅ | N/A | +| `type` | *"container_upload"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicdirectcaller.mdx b/docs/models/anthropicdirectcaller.mdx index 79c4f2e5d..cb1de94af 100644 --- a/docs/models/anthropicdirectcaller.mdx +++ b/docs/models/anthropicdirectcaller.mdx @@ -16,4 +16,4 @@ let value: AnthropicDirectCaller = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"direct"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"direct"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicdocumentblock.mdx b/docs/models/anthropicdocumentblock.mdx index 186bda94c..c70683d07 100644 --- a/docs/models/anthropicdocumentblock.mdx +++ b/docs/models/anthropicdocumentblock.mdx @@ -22,7 +22,7 @@ let value: AnthropicDocumentBlock = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `citations` | [models.AnthropicCitationsConfig](../models/anthropiccitationsconfig.mdx) | :heavy_minus_sign: | N/A | \{
"enabled": true
} | -| `source` | *models.AnthropicDocumentBlockSource* | :heavy_check_mark: | N/A | | -| `title` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.AnthropicDocumentBlockType](../models/anthropicdocumentblocktype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `citations` | [models.AnthropicCitationsConfig](../models/anthropiccitationsconfig.mdx) | ➖ | N/A | \{
"enabled": true
} | +| `source` | *models.AnthropicDocumentBlockSource* | ✅ | N/A | | +| `title` | *string* | ✅ | N/A | | +| `type` | [models.AnthropicDocumentBlockType](../models/anthropicdocumentblocktype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicdocumentblockparam.mdx b/docs/models/anthropicdocumentblockparam.mdx index 15f213d3f..0a52fa6bc 100644 --- a/docs/models/anthropicdocumentblockparam.mdx +++ b/docs/models/anthropicdocumentblockparam.mdx @@ -21,9 +21,9 @@ let value: AnthropicDocumentBlockParam = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `citations` | [models.AnthropicDocumentBlockParamCitations](../models/anthropicdocumentblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | -| `context` | *string* | :heavy_minus_sign: | N/A | | -| `source` | *models.AnthropicDocumentBlockParamSourceUnion* | :heavy_check_mark: | N/A | | -| `title` | *string* | :heavy_minus_sign: | N/A | | -| `type` | *"document"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `citations` | [models.AnthropicDocumentBlockParamCitations](../models/anthropicdocumentblockparamcitations.mdx) | ➖ | N/A | | +| `context` | *string* | ➖ | N/A | | +| `source` | *models.AnthropicDocumentBlockParamSourceUnion* | ✅ | N/A | | +| `title` | *string* | ➖ | N/A | | +| `type` | *"document"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicdocumentblockparamcitations.mdx b/docs/models/anthropicdocumentblockparamcitations.mdx index f878d9ec0..f64e09c40 100644 --- a/docs/models/anthropicdocumentblockparamcitations.mdx +++ b/docs/models/anthropicdocumentblockparamcitations.mdx @@ -14,4 +14,4 @@ let value: AnthropicDocumentBlockParamCitations = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `enabled` | *boolean* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicencryptedcodeexecutionresult.mdx b/docs/models/anthropicencryptedcodeexecutionresult.mdx index b944dd5dc..9c413bbf6 100644 --- a/docs/models/anthropicencryptedcodeexecutionresult.mdx +++ b/docs/models/anthropicencryptedcodeexecutionresult.mdx @@ -20,8 +20,8 @@ let value: AnthropicEncryptedCodeExecutionResult = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `content` | [models.AnthropicCodeExecutionOutput](../models/anthropiccodeexecutionoutput.mdx)[] | :heavy_check_mark: | N/A | -| `encryptedStdout` | *string* | :heavy_check_mark: | N/A | -| `returnCode` | *number* | :heavy_check_mark: | N/A | -| `stderr` | *string* | :heavy_check_mark: | N/A | -| `type` | *"encrypted_code_execution_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | [models.AnthropicCodeExecutionOutput](../models/anthropiccodeexecutionoutput.mdx)[] | ✅ | N/A | +| `encryptedStdout` | *string* | ✅ | N/A | +| `returnCode` | *number* | ✅ | N/A | +| `stderr` | *string* | ✅ | N/A | +| `type` | *"encrypted_code_execution_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicfile.mdx b/docs/models/anthropicfile.mdx index 9203981c4..d5becc457 100644 --- a/docs/models/anthropicfile.mdx +++ b/docs/models/anthropicfile.mdx @@ -25,11 +25,11 @@ let value: AnthropicFile = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `shape` | [models.AnthropicFileShape](../models/anthropicfileshape.mdx) | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `downloadable` | *boolean* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `mimeType` | *string* | :heavy_check_mark: | N/A | -| `sizeBytes` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicFileType](../models/anthropicfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [models.AnthropicFileShape](../models/anthropicfileshape.mdx) | ✅ | N/A | +| `createdAt` | *string* | ✅ | N/A | +| `downloadable` | *boolean* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `mimeType` | *string* | ✅ | N/A | +| `sizeBytes` | *number* | ✅ | N/A | +| `type` | [models.AnthropicFileType](../models/anthropicfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicfiledeleted.mdx b/docs/models/anthropicfiledeleted.mdx index a00d25863..2d70ecbb0 100644 --- a/docs/models/anthropicfiledeleted.mdx +++ b/docs/models/anthropicfiledeleted.mdx @@ -20,6 +20,6 @@ let value: AnthropicFileDeleted = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `shape` | *"anthropic"* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicFileDeletedType](../models/anthropicfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | *"anthropic"* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `type` | [models.AnthropicFileDeletedType](../models/anthropicfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicfiledocumentsource.mdx b/docs/models/anthropicfiledocumentsource.mdx index e9e3488ec..7fca45060 100644 --- a/docs/models/anthropicfiledocumentsource.mdx +++ b/docs/models/anthropicfiledocumentsource.mdx @@ -17,5 +17,5 @@ let value: AnthropicFileDocumentSource = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"file"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileId` | *string* | ✅ | N/A | +| `type` | *"file"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicfilelist.mdx b/docs/models/anthropicfilelist.mdx index 0f528f18b..41e11fd1d 100644 --- a/docs/models/anthropicfilelist.mdx +++ b/docs/models/anthropicfilelist.mdx @@ -22,8 +22,8 @@ let value: AnthropicFileList = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `shape` | *"anthropic"* | :heavy_check_mark: | N/A | -| `data` | [models.AnthropicFile](../models/anthropicfile.mdx)[] | :heavy_check_mark: | N/A | -| `firstId` | *string* | :heavy_check_mark: | N/A | -| `hasMore` | *boolean* | :heavy_check_mark: | N/A | -| `lastId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | *"anthropic"* | ✅ | N/A | +| `data` | [models.AnthropicFile](../models/anthropicfile.mdx)[] | ✅ | N/A | +| `firstId` | *string* | ✅ | N/A | +| `hasMore` | *boolean* | ✅ | N/A | +| `lastId` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicimageblockparam.mdx b/docs/models/anthropicimageblockparam.mdx index 2d955a4c9..da1a3a064 100644 --- a/docs/models/anthropicimageblockparam.mdx +++ b/docs/models/anthropicimageblockparam.mdx @@ -21,6 +21,6 @@ let value: AnthropicImageBlockParam = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `source` | *models.AnthropicImageBlockParamSource* | :heavy_check_mark: | N/A | | -| `type` | *"image"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `source` | *models.AnthropicImageBlockParamSource* | ✅ | N/A | | +| `type` | *"image"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicinputtokensclearatleast.mdx b/docs/models/anthropicinputtokensclearatleast.mdx index 4f8793969..2b14f55f6 100644 --- a/docs/models/anthropicinputtokensclearatleast.mdx +++ b/docs/models/anthropicinputtokensclearatleast.mdx @@ -17,5 +17,5 @@ let value: AnthropicInputTokensClearAtLeast = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [models.AnthropicInputTokensClearAtLeastType](../models/anthropicinputtokensclearatleasttype.mdx) | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.AnthropicInputTokensClearAtLeastType](../models/anthropicinputtokensclearatleasttype.mdx) | ✅ | N/A | +| `value` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicinputtokenstrigger.mdx b/docs/models/anthropicinputtokenstrigger.mdx index 6af2bd1fe..d1d4d2629 100644 --- a/docs/models/anthropicinputtokenstrigger.mdx +++ b/docs/models/anthropicinputtokenstrigger.mdx @@ -17,5 +17,5 @@ let value: AnthropicInputTokensTrigger = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"input_tokens"* | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"input_tokens"* | ✅ | N/A | +| `value` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicinputtransformation.mdx b/docs/models/anthropicinputtransformation.mdx index bfba8c5d4..9948ff20a 100644 --- a/docs/models/anthropicinputtransformation.mdx +++ b/docs/models/anthropicinputtransformation.mdx @@ -18,7 +18,7 @@ let value: AnthropicInputTransformation = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `path` | *string* | :heavy_minus_sign: | N/A | | -| `reason` | *string* | :heavy_minus_sign: | N/A | | -| `type` | *string* | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"path": "messages.1.content.0",
"reason": "prefix_binding_mismatch",
"type": "thinking_dropped"
} | \ No newline at end of file +| `path` | *string* | ➖ | N/A | | +| `reason` | *string* | ➖ | N/A | | +| `type` | *string* | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"path": "messages.1.content.0",
"reason": "prefix_binding_mismatch",
"type": "thinking_dropped"
} | \ No newline at end of file diff --git a/docs/models/anthropiciterationcachecreation.mdx b/docs/models/anthropiciterationcachecreation.mdx index c4c9d05a0..373e01cc6 100644 --- a/docs/models/anthropiciterationcachecreation.mdx +++ b/docs/models/anthropiciterationcachecreation.mdx @@ -14,5 +14,5 @@ let value: AnthropicIterationCacheCreation = {}; | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `ephemeral1hInputTokens` | *number* | :heavy_minus_sign: | N/A | -| `ephemeral5mInputTokens` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ephemeral1hInputTokens` | *number* | ➖ | N/A | +| `ephemeral5mInputTokens` | *number* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicmessageoutputconfig.mdx b/docs/models/anthropicmessageoutputconfig.mdx index 94dc46417..71c619850 100644 --- a/docs/models/anthropicmessageoutputconfig.mdx +++ b/docs/models/anthropicmessageoutputconfig.mdx @@ -14,4 +14,4 @@ let value: AnthropicMessageOutputConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `effort` | [models.AnthropicOutputEffort](../models/anthropicoutputeffort.mdx) | :heavy_minus_sign: | N/A | high | \ No newline at end of file +| `effort` | [models.AnthropicOutputEffort](../models/anthropicoutputeffort.mdx) | ➖ | N/A | high | \ No newline at end of file diff --git a/docs/models/anthropicmessageusageiteration.mdx b/docs/models/anthropicmessageusageiteration.mdx index 67ec03d53..4cc7c6381 100644 --- a/docs/models/anthropicmessageusageiteration.mdx +++ b/docs/models/anthropicmessageusageiteration.mdx @@ -16,10 +16,10 @@ let value: AnthropicMessageUsageIteration = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cacheCreationInputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `cacheReadInputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `inputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `outputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `model` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.AnthropicMessageUsageIterationType](../models/anthropicmessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cacheCreationInputTokens` | *number* | ➖ | N/A | | +| `cacheReadInputTokens` | *number* | ➖ | N/A | | +| `inputTokens` | *number* | ➖ | N/A | | +| `outputTokens` | *number* | ➖ | N/A | | +| `model` | *string* | ➖ | N/A | | +| `type` | [models.AnthropicMessageUsageIterationType](../models/anthropicmessageusageiterationtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicoutputtokensdetails.mdx b/docs/models/anthropicoutputtokensdetails.mdx index f1862c6b9..fa64f6f7e 100644 --- a/docs/models/anthropicoutputtokensdetails.mdx +++ b/docs/models/anthropicoutputtokensdetails.mdx @@ -16,4 +16,4 @@ let value: AnthropicOutputTokensDetails = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `thinkingTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `thinkingTokens` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicplaintextsource.mdx b/docs/models/anthropicplaintextsource.mdx index b591d27bc..ab0abe581 100644 --- a/docs/models/anthropicplaintextsource.mdx +++ b/docs/models/anthropicplaintextsource.mdx @@ -18,6 +18,6 @@ let value: AnthropicPlainTextSource = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | -| `mediaType` | [models.AnthropicPlainTextSourceMediaType](../models/anthropicplaintextsourcemediatype.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicPlainTextSourceType](../models/anthropicplaintextsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *string* | ✅ | N/A | +| `mediaType` | [models.AnthropicPlainTextSourceMediaType](../models/anthropicplaintextsourcemediatype.mdx) | ✅ | N/A | +| `type` | [models.AnthropicPlainTextSourceType](../models/anthropicplaintextsourcetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicredactedthinkingblock.mdx b/docs/models/anthropicredactedthinkingblock.mdx index 887c61b1d..76a8634f7 100644 --- a/docs/models/anthropicredactedthinkingblock.mdx +++ b/docs/models/anthropicredactedthinkingblock.mdx @@ -17,5 +17,5 @@ let value: AnthropicRedactedThinkingBlock = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `data` | *string* | :heavy_check_mark: | N/A | -| `type` | *"redacted_thinking"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *string* | ✅ | N/A | +| `type` | *"redacted_thinking"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicrefusalstopdetails.mdx b/docs/models/anthropicrefusalstopdetails.mdx index 4701d209e..3b1941e4a 100644 --- a/docs/models/anthropicrefusalstopdetails.mdx +++ b/docs/models/anthropicrefusalstopdetails.mdx @@ -20,6 +20,6 @@ let value: AnthropicRefusalStopDetails = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `category` | [models.AnthropicRefusalStopDetailsCategory](../models/anthropicrefusalstopdetailscategory.mdx) | :heavy_check_mark: | N/A | -| `explanation` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicRefusalStopDetailsType](../models/anthropicrefusalstopdetailstype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `category` | [models.AnthropicRefusalStopDetailsCategory](../models/anthropicrefusalstopdetailscategory.mdx) | ✅ | N/A | +| `explanation` | *string* | ✅ | N/A | +| `type` | [models.AnthropicRefusalStopDetailsType](../models/anthropicrefusalstopdetailstype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicsafeguard.mdx b/docs/models/anthropicsafeguard.mdx index 65d420c23..2c1ebdfb6 100644 --- a/docs/models/anthropicsafeguard.mdx +++ b/docs/models/anthropicsafeguard.mdx @@ -18,6 +18,6 @@ let value: AnthropicSafeguard = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `classifierContext` | Record\ | :heavy_minus_sign: | N/A | | -| `type` | *string* | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"classifier_context": \{
"permission_mode": "auto",
"v": 1
},
"type": "dangerous_tool_use"
} | \ No newline at end of file +| `classifierContext` | Record\ | ➖ | N/A | | +| `type` | *string* | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"classifier_context": \{
"permission_mode": "auto",
"v": 1
},
"type": "dangerous_tool_use"
} | \ No newline at end of file diff --git a/docs/models/anthropicsearchresultblockparam.mdx b/docs/models/anthropicsearchresultblockparam.mdx index 8cdb047a3..56f806969 100644 --- a/docs/models/anthropicsearchresultblockparam.mdx +++ b/docs/models/anthropicsearchresultblockparam.mdx @@ -24,9 +24,9 @@ let value: AnthropicSearchResultBlockParam = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `citations` | [models.AnthropicSearchResultBlockParamCitations](../models/anthropicsearchresultblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | -| `content` | [models.AnthropicTextBlockParam](../models/anthropictextblockparam.mdx)[] | :heavy_check_mark: | N/A | | -| `source` | *string* | :heavy_check_mark: | N/A | | -| `title` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"search_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `citations` | [models.AnthropicSearchResultBlockParamCitations](../models/anthropicsearchresultblockparamcitations.mdx) | ➖ | N/A | | +| `content` | [models.AnthropicTextBlockParam](../models/anthropictextblockparam.mdx)[] | ✅ | N/A | | +| `source` | *string* | ✅ | N/A | | +| `title` | *string* | ✅ | N/A | | +| `type` | *"search_result"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicsearchresultblockparamcitations.mdx b/docs/models/anthropicsearchresultblockparamcitations.mdx index f0bc6827f..c3b784c7b 100644 --- a/docs/models/anthropicsearchresultblockparamcitations.mdx +++ b/docs/models/anthropicsearchresultblockparamcitations.mdx @@ -14,4 +14,4 @@ let value: AnthropicSearchResultBlockParamCitations = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `enabled` | *boolean* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicservertoolusage.mdx b/docs/models/anthropicservertoolusage.mdx index a2af3124f..db64a00dd 100644 --- a/docs/models/anthropicservertoolusage.mdx +++ b/docs/models/anthropicservertoolusage.mdx @@ -17,5 +17,5 @@ let value: AnthropicServerToolUsage = { | Field | Type | Required | Description | | ------------------- | ------------------- | ------------------- | ------------------- | -| `webFetchRequests` | *number* | :heavy_check_mark: | N/A | -| `webSearchRequests` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `webFetchRequests` | *number* | ✅ | N/A | +| `webSearchRequests` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropictextblock.mdx b/docs/models/anthropictextblock.mdx index 4397e7346..6cc13528b 100644 --- a/docs/models/anthropictextblock.mdx +++ b/docs/models/anthropictextblock.mdx @@ -18,6 +18,6 @@ let value: AnthropicTextBlock = { | Field | Type | Required | Description | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `citations` | *models.AnthropicTextCitation*[] | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citations` | *models.AnthropicTextCitation*[] | ✅ | N/A | +| `text` | *string* | ✅ | N/A | +| `type` | *"text"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropictextblockparam.mdx b/docs/models/anthropictextblockparam.mdx index df34fd1a2..6f8166cab 100644 --- a/docs/models/anthropictextblockparam.mdx +++ b/docs/models/anthropictextblockparam.mdx @@ -17,7 +17,7 @@ let value: AnthropicTextBlockParam = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `citations` | *models.Citation*[] | :heavy_minus_sign: | N/A | | -| `text` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"text"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `citations` | *models.Citation*[] | ➖ | N/A | | +| `text` | *string* | ✅ | N/A | | +| `type` | *"text"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictexteditorcodeexecutioncreateresult.mdx b/docs/models/anthropictexteditorcodeexecutioncreateresult.mdx index f645f5715..ab73ce9c5 100644 --- a/docs/models/anthropictexteditorcodeexecutioncreateresult.mdx +++ b/docs/models/anthropictexteditorcodeexecutioncreateresult.mdx @@ -17,5 +17,5 @@ let value: AnthropicTextEditorCodeExecutionCreateResult = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `isFileUpdate` | *boolean* | :heavy_check_mark: | N/A | -| `type` | *"text_editor_code_execution_create_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `isFileUpdate` | *boolean* | ✅ | N/A | +| `type` | *"text_editor_code_execution_create_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropictexteditorcodeexecutionstrreplaceresult.mdx b/docs/models/anthropictexteditorcodeexecutionstrreplaceresult.mdx index 9131976da..119075f1f 100644 --- a/docs/models/anthropictexteditorcodeexecutionstrreplaceresult.mdx +++ b/docs/models/anthropictexteditorcodeexecutionstrreplaceresult.mdx @@ -21,9 +21,9 @@ let value: AnthropicTextEditorCodeExecutionStrReplaceResult = { | Field | Type | Required | Description | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `lines` | *string*[] | :heavy_check_mark: | N/A | -| `newLines` | *number* | :heavy_check_mark: | N/A | -| `newStart` | *number* | :heavy_check_mark: | N/A | -| `oldLines` | *number* | :heavy_check_mark: | N/A | -| `oldStart` | *number* | :heavy_check_mark: | N/A | -| `type` | *"text_editor_code_execution_str_replace_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `lines` | *string*[] | ✅ | N/A | +| `newLines` | *number* | ✅ | N/A | +| `newStart` | *number* | ✅ | N/A | +| `oldLines` | *number* | ✅ | N/A | +| `oldStart` | *number* | ✅ | N/A | +| `type` | *"text_editor_code_execution_str_replace_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropictexteditorcodeexecutiontoolresult.mdx b/docs/models/anthropictexteditorcodeexecutiontoolresult.mdx index 9c1d6a7e3..75f6bf452 100644 --- a/docs/models/anthropictexteditorcodeexecutiontoolresult.mdx +++ b/docs/models/anthropictexteditorcodeexecutiontoolresult.mdx @@ -25,6 +25,6 @@ let value: AnthropicTextEditorCodeExecutionToolResult = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.AnthropicTextEditorCodeExecutionContent* | :heavy_check_mark: | N/A | \{
"content": "file content",
"file_type": "text",
"num_lines": 10,
"start_line": 1,
"total_lines": 10,
"type": "text_editor_code_execution_view_result"
} | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"text_editor_code_execution_tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | *models.AnthropicTextEditorCodeExecutionContent* | ✅ | N/A | \{
"content": "file content",
"file_type": "text",
"num_lines": 10,
"start_line": 1,
"total_lines": 10,
"type": "text_editor_code_execution_view_result"
} | +| `toolUseId` | *string* | ✅ | N/A | | +| `type` | *"text_editor_code_execution_tool_result"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictexteditorcodeexecutiontoolresulterror.mdx b/docs/models/anthropictexteditorcodeexecutiontoolresulterror.mdx index 434f11435..0db6cb0d1 100644 --- a/docs/models/anthropictexteditorcodeexecutiontoolresulterror.mdx +++ b/docs/models/anthropictexteditorcodeexecutiontoolresulterror.mdx @@ -18,6 +18,6 @@ let value: AnthropicTextEditorCodeExecutionToolResultError = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `errorCode` | [models.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../models/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `errorMessage` | *string* | :heavy_check_mark: | N/A | -| `type` | *"text_editor_code_execution_tool_result_error"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `errorCode` | [models.AnthropicTextEditorCodeExecutionToolResultErrorErrorCode](../models/anthropictexteditorcodeexecutiontoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `errorMessage` | *string* | ✅ | N/A | +| `type` | *"text_editor_code_execution_tool_result_error"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropictexteditorcodeexecutionviewresult.mdx b/docs/models/anthropictexteditorcodeexecutionviewresult.mdx index d721c5b74..62453947d 100644 --- a/docs/models/anthropictexteditorcodeexecutionviewresult.mdx +++ b/docs/models/anthropictexteditorcodeexecutionviewresult.mdx @@ -21,9 +21,9 @@ let value: AnthropicTextEditorCodeExecutionViewResult = { | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `content` | *string* | :heavy_check_mark: | N/A | -| `fileType` | [models.FileType](../models/filetype.mdx) | :heavy_check_mark: | N/A | -| `numLines` | *number* | :heavy_check_mark: | N/A | -| `startLine` | *number* | :heavy_check_mark: | N/A | -| `totalLines` | *number* | :heavy_check_mark: | N/A | -| `type` | *"text_editor_code_execution_view_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *string* | ✅ | N/A | +| `fileType` | [models.FileType](../models/filetype.mdx) | ✅ | N/A | +| `numLines` | *number* | ✅ | N/A | +| `startLine` | *number* | ✅ | N/A | +| `totalLines` | *number* | ✅ | N/A | +| `type` | *"text_editor_code_execution_view_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicthinkingblock.mdx b/docs/models/anthropicthinkingblock.mdx index 9e42fcaae..cb1d5b277 100644 --- a/docs/models/anthropicthinkingblock.mdx +++ b/docs/models/anthropicthinkingblock.mdx @@ -18,6 +18,6 @@ let value: AnthropicThinkingBlock = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `signature` | *string* | :heavy_check_mark: | N/A | -| `thinking` | *string* | :heavy_check_mark: | N/A | -| `type` | *"thinking"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `signature` | *string* | ✅ | N/A | +| `thinking` | *string* | ✅ | N/A | +| `type` | *"thinking"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicthinkingblockbinding.mdx b/docs/models/anthropicthinkingblockbinding.mdx index ac2385ae8..9990bcb03 100644 --- a/docs/models/anthropicthinkingblockbinding.mdx +++ b/docs/models/anthropicthinkingblockbinding.mdx @@ -14,5 +14,5 @@ let value: AnthropicThinkingBlockBinding = {}; | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ~~`mismatchBehavior`~~ | [models.MismatchBehavior](../models/mismatchbehavior.mdx) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: legacy alias of prefix_mismatch_behavior. Send only one of the two. | -| `prefixMismatchBehavior` | [models.PrefixMismatchBehavior](../models/prefixmismatchbehavior.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| ~~`mismatchBehavior`~~ | [models.MismatchBehavior](../models/mismatchbehavior.mdx) | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: legacy alias of prefix_mismatch_behavior. Send only one of the two. | +| `prefixMismatchBehavior` | [models.PrefixMismatchBehavior](../models/prefixmismatchbehavior.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicthinkingturns.mdx b/docs/models/anthropicthinkingturns.mdx index 8667e2a01..c799e9ef8 100644 --- a/docs/models/anthropicthinkingturns.mdx +++ b/docs/models/anthropicthinkingturns.mdx @@ -17,5 +17,5 @@ let value: AnthropicThinkingTurns = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `type` | [models.AnthropicThinkingTurnsType](../models/anthropicthinkingturnstype.mdx) | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.AnthropicThinkingTurnsType](../models/anthropicthinkingturnstype.mdx) | ✅ | N/A | +| `value` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropictoolreference.mdx b/docs/models/anthropictoolreference.mdx index 68537c494..d8b456d4d 100644 --- a/docs/models/anthropictoolreference.mdx +++ b/docs/models/anthropictoolreference.mdx @@ -17,5 +17,5 @@ let value: AnthropicToolReference = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `toolName` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicToolReferenceType](../models/anthropictoolreferencetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `toolName` | *string* | ✅ | N/A | +| `type` | [models.AnthropicToolReferenceType](../models/anthropictoolreferencetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropictoolsearchresult.mdx b/docs/models/anthropictoolsearchresult.mdx index 3bc89797d..02846dc3d 100644 --- a/docs/models/anthropictoolsearchresult.mdx +++ b/docs/models/anthropictoolsearchresult.mdx @@ -22,5 +22,5 @@ let value: AnthropicToolSearchResult = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `toolReferences` | [models.AnthropicToolReference](../models/anthropictoolreference.mdx)[] | :heavy_check_mark: | N/A | -| `type` | *"tool_search_tool_search_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `toolReferences` | [models.AnthropicToolReference](../models/anthropictoolreference.mdx)[] | ✅ | N/A | +| `type` | *"tool_search_tool_search_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropictoolsearchresulterror.mdx b/docs/models/anthropictoolsearchresulterror.mdx index cfe6365d1..a4588ad24 100644 --- a/docs/models/anthropictoolsearchresulterror.mdx +++ b/docs/models/anthropictoolsearchresulterror.mdx @@ -18,6 +18,6 @@ let value: AnthropicToolSearchResultError = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `errorCode` | [models.AnthropicServerToolErrorCode](../models/anthropicservertoolerrorcode.mdx) | :heavy_check_mark: | N/A | unavailable | -| `errorMessage` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"tool_search_tool_result_error"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `errorCode` | [models.AnthropicServerToolErrorCode](../models/anthropicservertoolerrorcode.mdx) | ✅ | N/A | unavailable | +| `errorMessage` | *string* | ✅ | N/A | | +| `type` | *"tool_search_tool_result_error"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictoolsearchtoolbm25.mdx b/docs/models/anthropictoolsearchtoolbm25.mdx index af43eff73..ea8e3cd49 100644 --- a/docs/models/anthropictoolsearchtoolbm25.mdx +++ b/docs/models/anthropictoolsearchtoolbm25.mdx @@ -17,9 +17,9 @@ let value: AnthropicToolSearchToolBm25 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | -| `name` | [models.AnthropicToolSearchToolBm25Name](../models/anthropictoolsearchtoolbm25name.mdx) | :heavy_check_mark: | N/A | | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | | -| `type` | [models.AnthropicToolSearchToolBm25Type](../models/anthropictoolsearchtoolbm25type.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | ➖ | N/A | [
"direct"
] | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `deferLoading` | *boolean* | ➖ | N/A | | +| `name` | [models.AnthropicToolSearchToolBm25Name](../models/anthropictoolsearchtoolbm25name.mdx) | ✅ | N/A | | +| `strict` | *boolean* | ➖ | N/A | | +| `type` | [models.AnthropicToolSearchToolBm25Type](../models/anthropictoolsearchtoolbm25type.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictoolsearchtoolregex.mdx b/docs/models/anthropictoolsearchtoolregex.mdx index 0d46476a9..3da7eb544 100644 --- a/docs/models/anthropictoolsearchtoolregex.mdx +++ b/docs/models/anthropictoolsearchtoolregex.mdx @@ -17,9 +17,9 @@ let value: AnthropicToolSearchToolRegex = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | -| `name` | [models.AnthropicToolSearchToolRegexName](../models/anthropictoolsearchtoolregexname.mdx) | :heavy_check_mark: | N/A | | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | | -| `type` | [models.AnthropicToolSearchToolRegexType](../models/anthropictoolsearchtoolregextype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | ➖ | N/A | [
"direct"
] | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `deferLoading` | *boolean* | ➖ | N/A | | +| `name` | [models.AnthropicToolSearchToolRegexName](../models/anthropictoolsearchtoolregexname.mdx) | ✅ | N/A | | +| `strict` | *boolean* | ➖ | N/A | | +| `type` | [models.AnthropicToolSearchToolRegexType](../models/anthropictoolsearchtoolregextype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictoolsearchtoolresult.mdx b/docs/models/anthropictoolsearchtoolresult.mdx index 897196bd8..acab0f482 100644 --- a/docs/models/anthropictoolsearchtoolresult.mdx +++ b/docs/models/anthropictoolsearchtoolresult.mdx @@ -26,6 +26,6 @@ let value: AnthropicToolSearchToolResult = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.AnthropicToolSearchContent* | :heavy_check_mark: | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"tool_search_tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | *models.AnthropicToolSearchContent* | ✅ | N/A | \{
"tool_references": [
\{
"tool_name": "my_tool",
"type": "tool_reference"
}
],
"type": "tool_search_tool_search_result"
} | +| `toolUseId` | *string* | ✅ | N/A | | +| `type` | *"tool_search_tool_result"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictooluseblock.mdx b/docs/models/anthropictooluseblock.mdx index e3e3ddc31..3a6509dac 100644 --- a/docs/models/anthropictooluseblock.mdx +++ b/docs/models/anthropictooluseblock.mdx @@ -21,8 +21,8 @@ let value: AnthropicToolUseBlock = { | Field | Type | Required | Description | Example | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `caller` | *models.AnthropicCaller* | :heavy_check_mark: | N/A | \{
"type": "direct"
} | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `input` | *any* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"tool_use"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `caller` | *models.AnthropicCaller* | ✅ | N/A | \{
"type": "direct"
} | +| `id` | *string* | ✅ | N/A | | +| `input` | *any* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `type` | *"tool_use"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropictooluseskeep.mdx b/docs/models/anthropictooluseskeep.mdx index feb528efc..1d739b0d2 100644 --- a/docs/models/anthropictooluseskeep.mdx +++ b/docs/models/anthropictooluseskeep.mdx @@ -17,5 +17,5 @@ let value: AnthropicToolUsesKeep = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `type` | [models.AnthropicToolUsesKeepType](../models/anthropictooluseskeeptype.mdx) | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.AnthropicToolUsesKeepType](../models/anthropictooluseskeeptype.mdx) | ✅ | N/A | +| `value` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropictoolusestrigger.mdx b/docs/models/anthropictoolusestrigger.mdx index 7571fca46..aab53a17d 100644 --- a/docs/models/anthropictoolusestrigger.mdx +++ b/docs/models/anthropictoolusestrigger.mdx @@ -17,5 +17,5 @@ let value: AnthropicToolUsesTrigger = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"tool_uses"* | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"tool_uses"* | ✅ | N/A | +| `value` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicunknownusageiteration.mdx b/docs/models/anthropicunknownusageiteration.mdx index fa2b03440..52ea1e176 100644 --- a/docs/models/anthropicunknownusageiteration.mdx +++ b/docs/models/anthropicunknownusageiteration.mdx @@ -16,9 +16,9 @@ let value: AnthropicUnknownUsageIteration = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | -| `cacheCreationInputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `cacheReadInputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `inputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `outputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `type` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheCreation` | [models.AnthropicIterationCacheCreation](../models/anthropiciterationcachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `cacheCreationInputTokens` | *number* | ➖ | N/A | | +| `cacheReadInputTokens` | *number* | ➖ | N/A | | +| `inputTokens` | *number* | ➖ | N/A | | +| `outputTokens` | *number* | ➖ | N/A | | +| `type` | *string* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicurlimagesource.mdx b/docs/models/anthropicurlimagesource.mdx index c72128244..2682b255c 100644 --- a/docs/models/anthropicurlimagesource.mdx +++ b/docs/models/anthropicurlimagesource.mdx @@ -17,5 +17,5 @@ let value: AnthropicUrlImageSource = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"url"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"url"* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicurlpdfsource.mdx b/docs/models/anthropicurlpdfsource.mdx index 479145f46..c01191646 100644 --- a/docs/models/anthropicurlpdfsource.mdx +++ b/docs/models/anthropicurlpdfsource.mdx @@ -17,5 +17,5 @@ let value: AnthropicUrlPdfSource = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"url"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"url"* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicwebfetchblock.mdx b/docs/models/anthropicwebfetchblock.mdx index ac0e6d3f2..4edea631a 100644 --- a/docs/models/anthropicwebfetchblock.mdx +++ b/docs/models/anthropicwebfetchblock.mdx @@ -27,7 +27,7 @@ let value: AnthropicWebFetchBlock = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | [models.AnthropicDocumentBlock](../models/anthropicdocumentblock.mdx) | :heavy_check_mark: | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | -| `retrievedAt` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"web_fetch_result"* | :heavy_check_mark: | N/A | | -| `url` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | [models.AnthropicDocumentBlock](../models/anthropicdocumentblock.mdx) | ✅ | N/A | \{
"citations": null,
"source": \{
"data": "Hello, world!",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
} | +| `retrievedAt` | *string* | ✅ | N/A | | +| `type` | *"web_fetch_result"* | ✅ | N/A | | +| `url` | *string* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicwebfetchtoolresult.mdx b/docs/models/anthropicwebfetchtoolresult.mdx index 3f0652bde..c6510ca2b 100644 --- a/docs/models/anthropicwebfetchtoolresult.mdx +++ b/docs/models/anthropicwebfetchtoolresult.mdx @@ -34,7 +34,7 @@ let value: AnthropicWebFetchToolResult = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `caller` | *models.AnthropicCaller* | :heavy_check_mark: | N/A | \{
"type": "direct"
} | -| `content` | *models.AnthropicWebFetchContent* | :heavy_check_mark: | N/A | \{
"content": \{
"citations": null,
"source": \{
"data": "",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
},
"retrieved_at": null,
"type": "web_fetch_result",
"url": "https://example.com"
} | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"web_fetch_tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `caller` | *models.AnthropicCaller* | ✅ | N/A | \{
"type": "direct"
} | +| `content` | *models.AnthropicWebFetchContent* | ✅ | N/A | \{
"content": \{
"citations": null,
"source": \{
"data": "",
"media_type": "text/plain",
"type": "text"
},
"title": null,
"type": "document"
},
"retrieved_at": null,
"type": "web_fetch_result",
"url": "https://example.com"
} | +| `toolUseId` | *string* | ✅ | N/A | | +| `type` | *"web_fetch_tool_result"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicwebfetchtoolresulterror.mdx b/docs/models/anthropicwebfetchtoolresulterror.mdx index 6ef7bf344..00937ecb7 100644 --- a/docs/models/anthropicwebfetchtoolresulterror.mdx +++ b/docs/models/anthropicwebfetchtoolresulterror.mdx @@ -17,5 +17,5 @@ let value: AnthropicWebFetchToolResultError = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `errorCode` | [models.AnthropicWebFetchToolResultErrorErrorCode](../models/anthropicwebfetchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `type` | *"web_fetch_tool_result_error"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `errorCode` | [models.AnthropicWebFetchToolResultErrorErrorCode](../models/anthropicwebfetchtoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `type` | *"web_fetch_tool_result_error"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicwebsearchresult.mdx b/docs/models/anthropicwebsearchresult.mdx index 55c8f774e..f49223b83 100644 --- a/docs/models/anthropicwebsearchresult.mdx +++ b/docs/models/anthropicwebsearchresult.mdx @@ -20,8 +20,8 @@ let value: AnthropicWebSearchResult = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `encryptedContent` | *string* | :heavy_check_mark: | N/A | -| `pageAge` | *string* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicWebSearchResultType](../models/anthropicwebsearchresulttype.mdx) | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `encryptedContent` | *string* | ✅ | N/A | +| `pageAge` | *string* | ✅ | N/A | +| `title` | *string* | ✅ | N/A | +| `type` | [models.AnthropicWebSearchResultType](../models/anthropicwebsearchresulttype.mdx) | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicwebsearchresultblockparam.mdx b/docs/models/anthropicwebsearchresultblockparam.mdx index a862a6575..d498828b0 100644 --- a/docs/models/anthropicwebsearchresultblockparam.mdx +++ b/docs/models/anthropicwebsearchresultblockparam.mdx @@ -19,8 +19,8 @@ let value: AnthropicWebSearchResultBlockParam = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `encryptedContent` | *string* | :heavy_check_mark: | N/A | -| `pageAge` | *string* | :heavy_minus_sign: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicWebSearchResultBlockParamType](../models/anthropicwebsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `encryptedContent` | *string* | ✅ | N/A | +| `pageAge` | *string* | ➖ | N/A | +| `title` | *string* | ✅ | N/A | +| `type` | [models.AnthropicWebSearchResultBlockParamType](../models/anthropicwebsearchresultblockparamtype.mdx) | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicwebsearchtoolresult.mdx b/docs/models/anthropicwebsearchtoolresult.mdx index 3204479a8..abc3ac7d6 100644 --- a/docs/models/anthropicwebsearchtoolresult.mdx +++ b/docs/models/anthropicwebsearchtoolresult.mdx @@ -24,7 +24,7 @@ let value: AnthropicWebSearchToolResult = { | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `caller` | *models.AnthropicCaller* | :heavy_check_mark: | N/A | \{
"type": "direct"
} | -| `content` | *models.AnthropicWebSearchToolResultContent* | :heavy_check_mark: | N/A | | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"web_search_tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `caller` | *models.AnthropicCaller* | ✅ | N/A | \{
"type": "direct"
} | +| `content` | *models.AnthropicWebSearchToolResultContent* | ✅ | N/A | | +| `toolUseId` | *string* | ✅ | N/A | | +| `type` | *"web_search_tool_result"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/anthropicwebsearchtoolresulterror.mdx b/docs/models/anthropicwebsearchtoolresulterror.mdx index fe42514e8..ee6a753f8 100644 --- a/docs/models/anthropicwebsearchtoolresulterror.mdx +++ b/docs/models/anthropicwebsearchtoolresulterror.mdx @@ -17,5 +17,5 @@ let value: AnthropicWebSearchToolResultError = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `errorCode` | [models.AnthropicWebSearchToolResultErrorErrorCode](../models/anthropicwebsearchtoolresulterrorerrorcode.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.AnthropicWebSearchToolResultErrorType](../models/anthropicwebsearchtoolresulterrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `errorCode` | [models.AnthropicWebSearchToolResultErrorErrorCode](../models/anthropicwebsearchtoolresulterrorerrorcode.mdx) | ✅ | N/A | +| `type` | [models.AnthropicWebSearchToolResultErrorType](../models/anthropicwebsearchtoolresulterrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/anthropicwebsearchtooluserlocation.mdx b/docs/models/anthropicwebsearchtooluserlocation.mdx index 6d7fac672..262663143 100644 --- a/docs/models/anthropicwebsearchtooluserlocation.mdx +++ b/docs/models/anthropicwebsearchtooluserlocation.mdx @@ -16,8 +16,8 @@ let value: AnthropicWebSearchToolUserLocation = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.AnthropicWebSearchToolUserLocationType](../models/anthropicwebsearchtooluserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `city` | *string* | ➖ | N/A | +| `country` | *string* | ➖ | N/A | +| `region` | *string* | ➖ | N/A | +| `timezone` | *string* | ➖ | N/A | +| `type` | [models.AnthropicWebSearchToolUserLocationType](../models/anthropicwebsearchtooluserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/applypatchcallitem.mdx b/docs/models/applypatchcallitem.mdx index de72aaf7f..7e4c7de79 100644 --- a/docs/models/applypatchcallitem.mdx +++ b/docs/models/applypatchcallitem.mdx @@ -25,8 +25,8 @@ let value: ApplyPatchCallItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `operation` | *models.ApplyPatchCallOperation* | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | -| `status` | [models.ApplyPatchCallStatus](../models/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | [models.ApplyPatchCallItemType](../models/applypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `operation` | *models.ApplyPatchCallOperation* | ✅ | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | +| `status` | [models.ApplyPatchCallStatus](../models/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | +| `type` | [models.ApplyPatchCallItemType](../models/applypatchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/applypatchcalloperationdiffdeltaevent.mdx b/docs/models/applypatchcalloperationdiffdeltaevent.mdx index 850d83a81..82d74fe70 100644 --- a/docs/models/applypatchcalloperationdiffdeltaevent.mdx +++ b/docs/models/applypatchcalloperationdiffdeltaevent.mdx @@ -22,8 +22,8 @@ let value: ApplyPatchCallOperationDiffDeltaEvent = { | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.apply_patch_call_operation_diff.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.apply_patch_call_operation_diff.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/applypatchcalloperationdiffdoneevent.mdx b/docs/models/applypatchcalloperationdiffdoneevent.mdx index b60d252e4..a30f6c0b9 100644 --- a/docs/models/applypatchcalloperationdiffdoneevent.mdx +++ b/docs/models/applypatchcalloperationdiffdoneevent.mdx @@ -22,8 +22,8 @@ let value: ApplyPatchCallOperationDiffDoneEvent = { | Field | Type | Required | Description | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `diff` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.apply_patch_call_operation_diff.done"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `diff` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.apply_patch_call_operation_diff.done"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/applypatchcalloutputitem.mdx b/docs/models/applypatchcalloutputitem.mdx index c53ae67eb..6601082d4 100644 --- a/docs/models/applypatchcalloutputitem.mdx +++ b/docs/models/applypatchcalloutputitem.mdx @@ -20,8 +20,8 @@ let value: ApplyPatchCallOutputItem = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `output` | *string* | :heavy_minus_sign: | N/A | -| `status` | [models.ApplyPatchCallOutputItemStatus](../models/applypatchcalloutputitemstatus.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.ApplyPatchCallOutputItemType](../models/applypatchcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | +| `id` | *string* | ➖ | N/A | +| `output` | *string* | ➖ | N/A | +| `status` | [models.ApplyPatchCallOutputItemStatus](../models/applypatchcalloutputitemstatus.mdx) | ✅ | N/A | +| `type` | [models.ApplyPatchCallOutputItemType](../models/applypatchcalloutputitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/applypatchcreatefileoperation.mdx b/docs/models/applypatchcreatefileoperation.mdx index c330e9813..b19975b7e 100644 --- a/docs/models/applypatchcreatefileoperation.mdx +++ b/docs/models/applypatchcreatefileoperation.mdx @@ -20,6 +20,6 @@ let value: ApplyPatchCreateFileOperation = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `diff` | *string* | :heavy_check_mark: | N/A | -| `path` | *string* | :heavy_check_mark: | N/A | -| `type` | *"create_file"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `diff` | *string* | ✅ | N/A | +| `path` | *string* | ✅ | N/A | +| `type` | *"create_file"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/applypatchdeletefileoperation.mdx b/docs/models/applypatchdeletefileoperation.mdx index cfe50dc31..d49cc6e71 100644 --- a/docs/models/applypatchdeletefileoperation.mdx +++ b/docs/models/applypatchdeletefileoperation.mdx @@ -19,5 +19,5 @@ let value: ApplyPatchDeleteFileOperation = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `path` | *string* | :heavy_check_mark: | N/A | -| `type` | *"delete_file"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `path` | *string* | ✅ | N/A | +| `type` | *"delete_file"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/applypatchservertool.mdx b/docs/models/applypatchservertool.mdx index 09945d14e..0b9ea2b09 100644 --- a/docs/models/applypatchservertool.mdx +++ b/docs/models/applypatchservertool.mdx @@ -18,4 +18,4 @@ let value: ApplyPatchServerTool = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `type` | [models.ApplyPatchServerToolType](../models/applypatchservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ApplyPatchServerToolType](../models/applypatchservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/applypatchservertoolconfig.mdx b/docs/models/applypatchservertoolconfig.mdx index ef60a7687..b2b675514 100644 --- a/docs/models/applypatchservertoolconfig.mdx +++ b/docs/models/applypatchservertoolconfig.mdx @@ -16,4 +16,4 @@ let value: ApplyPatchServerToolConfig = {}; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [models.ApplyPatchEngineEnum](../models/applypatchengineenum.mdx) | :heavy_minus_sign: | Which apply_patch engine to use. "auto" (default) uses native passthrough when the endpoint advertises native apply_patch support, otherwise falls back to OpenRouter's HITL validator. "native" forces native passthrough — when the endpoint does not support native, the request falls back to HITL. "openrouter" always runs the HITL validator. Native passthrough streams the diff incrementally via `apply_patch_call_operation_diff.delta` events; HITL buffers the diff for atomic delivery as a single delta. | auto | \ No newline at end of file +| `engine` | [models.ApplyPatchEngineEnum](../models/applypatchengineenum.mdx) | ➖ | Which apply_patch engine to use. "auto" (default) uses native passthrough when the endpoint advertises native apply_patch support, otherwise falls back to OpenRouter's HITL validator. "native" forces native passthrough — when the endpoint does not support native, the request falls back to HITL. "openrouter" always runs the HITL validator. Native passthrough streams the diff incrementally via `apply_patch_call_operation_diff.delta` events; HITL buffers the diff for atomic delivery as a single delta. | auto | \ No newline at end of file diff --git a/docs/models/applypatchservertoolopenrouter.mdx b/docs/models/applypatchservertoolopenrouter.mdx index dbce89799..16d4a9036 100644 --- a/docs/models/applypatchservertoolopenrouter.mdx +++ b/docs/models/applypatchservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: ApplyPatchServerToolOpenRouter = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `parameters` | [models.ApplyPatchServerToolConfig](../models/applypatchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | -| `type` | [models.ApplyPatchServerToolOpenRouterType](../models/applypatchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.ApplyPatchServerToolConfig](../models/applypatchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | +| `type` | [models.ApplyPatchServerToolOpenRouterType](../models/applypatchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/applypatchupdatefileoperation.mdx b/docs/models/applypatchupdatefileoperation.mdx index 147663db0..2997f1f35 100644 --- a/docs/models/applypatchupdatefileoperation.mdx +++ b/docs/models/applypatchupdatefileoperation.mdx @@ -20,6 +20,6 @@ let value: ApplyPatchUpdateFileOperation = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `diff` | *string* | :heavy_check_mark: | N/A | -| `path` | *string* | :heavy_check_mark: | N/A | -| `type` | *"update_file"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `diff` | *string* | ✅ | N/A | +| `path` | *string* | ✅ | N/A | +| `type` | *"update_file"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/apprankingsitem.mdx b/docs/models/apprankingsitem.mdx index f06e43572..741559e5a 100644 --- a/docs/models/apprankingsitem.mdx +++ b/docs/models/apprankingsitem.mdx @@ -20,8 +20,8 @@ let value: AppRankingsItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `appId` | *number* | :heavy_check_mark: | Stable numeric identifier of the app on OpenRouter. | 12345 | -| `appName` | *string* | :heavy_check_mark: | Public display name of the app. | Cline | -| `rank` | *number* | :heavy_check_mark: | 1-based position of the app within this response, per the requested `sort`. | 1 | -| `totalRequests` | *number* | :heavy_check_mark: | Number of requests attributed to the app inside the date window. | 4321 | -| `totalTokens` | *string* | :heavy_check_mark: | Sum of `prompt_tokens + completion_tokens` attributed to the app inside the date window, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file +| `appId` | *number* | ✅ | Stable numeric identifier of the app on OpenRouter. | 12345 | +| `appName` | *string* | ✅ | Public display name of the app. | Cline | +| `rank` | *number* | ✅ | 1-based position of the app within this response, per the requested `sort`. | 1 | +| `totalRequests` | *number* | ✅ | Number of requests attributed to the app inside the date window. | 4321 | +| `totalTokens` | *string* | ✅ | Sum of `prompt_tokens + completion_tokens` attributed to the app inside the date window, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file diff --git a/docs/models/apprankingsresponse.mdx b/docs/models/apprankingsresponse.mdx index 22df1b089..c66619057 100644 --- a/docs/models/apprankingsresponse.mdx +++ b/docs/models/apprankingsresponse.mdx @@ -37,5 +37,5 @@ let value: AppRankingsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.AppRankingsItem](../models/apprankingsitem.mdx)[] | :heavy_check_mark: | Apps ranked per the requested `sort`, re-numbered 1..N after category filtering. `popular` sorts by `total_tokens` descending; `trending` sorts by absolute excess token growth descending and may return fewer than `limit` rows when few apps are growing. | | -| `meta` | [models.RankingsDailyMeta](../models/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `data` | [models.AppRankingsItem](../models/apprankingsitem.mdx)[] | ✅ | Apps ranked per the requested `sort`, re-numbered 1..N after category filtering. `popular` sorts by `total_tokens` descending; `trending` sorts by absolute excess token growth descending and may return fewer than `limit` rows when few apps are growing. | | +| `meta` | [models.RankingsDailyMeta](../models/rankingsdailymeta.mdx) | ✅ | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/architecture.mdx b/docs/models/architecture.mdx index 059b7822a..4b3399c53 100644 --- a/docs/models/architecture.mdx +++ b/docs/models/architecture.mdx @@ -26,8 +26,8 @@ let value: Architecture = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `inputModalities` | [models.InputModality](../models/inputmodality.mdx)[] | :heavy_check_mark: | Supported input modalities | | -| `instructType` | [models.InstructType](../models/instructtype.mdx) | :heavy_check_mark: | Instruction format type | chatml | -| `modality` | *string* | :heavy_check_mark: | Primary modality of the model | text | -| `outputModalities` | [models.OutputModality](../models/outputmodality.mdx)[] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [models.ModelGroup](../models/modelgroup.mdx) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file +| `inputModalities` | [models.InputModality](../models/inputmodality.mdx)[] | ✅ | Supported input modalities | | +| `instructType` | [models.InstructType](../models/instructtype.mdx) | ✅ | Instruction format type | chatml | +| `modality` | *string* | ✅ | Primary modality of the model | text | +| `outputModalities` | [models.OutputModality](../models/outputmodality.mdx)[] | ✅ | Supported output modalities | | +| `tokenizer` | [models.ModelGroup](../models/modelgroup.mdx) | ✅ | N/A | GPT | \ No newline at end of file diff --git a/docs/models/audiourl.mdx b/docs/models/audiourl.mdx index 147f6e10f..f0ab3debb 100644 --- a/docs/models/audiourl.mdx +++ b/docs/models/audiourl.mdx @@ -16,4 +16,4 @@ let value: AudioUrl = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/autobetarouterplugin.mdx b/docs/models/autobetarouterplugin.mdx index 0e45a9570..7ac2c7149 100644 --- a/docs/models/autobetarouterplugin.mdx +++ b/docs/models/autobetarouterplugin.mdx @@ -16,9 +16,9 @@ let value: AutoBetaRouterPlugin = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedModels` | *string*[] | :heavy_minus_sign: | List of model patterns to filter which models the auto-beta-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | -| ~~`costQualityTradeoff`~~ | *number* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-beta-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | -| `costTier` | [models.AutoBetaRouterPluginCostTier](../models/autobetarouterplugincosttier.mdx) | :heavy_minus_sign: | Named cost/quality setting. For auto-beta-router, tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | -| `excludedModels` | *string*[] | :heavy_minus_sign: | List of model patterns to exclude from auto-beta-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | -| `id` | *"auto-beta-router"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowedModels` | *string*[] | ➖ | List of model patterns to filter which models the auto-beta-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | +| ~~`costQualityTradeoff`~~ | *number* | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-beta-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | +| `costTier` | [models.AutoBetaRouterPluginCostTier](../models/autobetarouterplugincosttier.mdx) | ➖ | Named cost/quality setting. For auto-beta-router, tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | +| `enabled` | *boolean* | ➖ | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | +| `excludedModels` | *string*[] | ➖ | List of model patterns to exclude from auto-beta-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | +| `id` | *"auto-beta-router"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/autorouterplugin.mdx b/docs/models/autorouterplugin.mdx index 2b78a2cc6..d0246a81e 100644 --- a/docs/models/autorouterplugin.mdx +++ b/docs/models/autorouterplugin.mdx @@ -16,10 +16,10 @@ let value: AutoRouterPlugin = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedModels` | *string*[] | :heavy_minus_sign: | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | -| ~~`costQualityTradeoff`~~ | *number* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | -| `costTier` | [models.AutoRouterPluginCostTier](../models/autorouterplugincosttier.mdx) | :heavy_minus_sign: | Named cost/quality setting. Tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `excludedModels` | *string*[] | :heavy_minus_sign: | List of model patterns to exclude from auto-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | -| `id` | *"auto-router"* | :heavy_check_mark: | N/A | | -| `pinModel` | *boolean* | :heavy_minus_sign: | When true, reuses the model from the most recent assistant message's `model` attribute for subsequent turns. Defaults to false. | false | \ No newline at end of file +| `allowedModels` | *string*[] | ➖ | List of model patterns to filter which models the auto-router can route between. Supports wildcards (e.g., "anthropic/*" matches all Anthropic models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When not specified, every model ranked for the classified task type is a candidate, falling back to a default model set when rankings are unavailable. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | +| ~~`costQualityTradeoff`~~ | *number* | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use cost_tier instead. Balances routing between cost and quality on a 0-10 scale. The auto-router ranks models for the classified task type by community spend share, then filters candidates by their average cost per generation for that task. Higher values favor cheaper models: 10 keeps only models around the cheapest 10th percentile, while 0 permits models up to the 90th percentile for cost. Defaults to 9 when no cost setting is provided. It remains supported and retains ceiling behavior, but cost_tier takes precedence when both are provided. | 9 | +| `costTier` | [models.AutoRouterPluginCostTier](../models/autorouterplugincosttier.mdx) | ➖ | Named cost/quality setting. Tiers select cost-percentile bands: low = [0, 20), medium = [20, 40), high = [40, 60), xhigh = [60, 80), and max = [80, 100]. Takes precedence over the deprecated numeric cost_quality_tradeoff when both are provided. | low | +| `enabled` | *boolean* | ➖ | Set to false to disable the auto-router plugin for this request. Defaults to true. | | +| `excludedModels` | *string*[] | ➖ | List of model patterns to exclude from auto-router selection. Supports wildcards (e.g., "meta-llama/*" excludes all Llama models). Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after allowed_models, so an excluded pattern always wins over an allowed one. | [
"openai/gpt-4o",
"meta-llama/*"
] | +| `id` | *"auto-router"* | ✅ | N/A | | +| `pinModel` | *boolean* | ➖ | When true, reuses the model from the most recent assistant message's `model` attribute for subsequent turns. Defaults to false. | false | \ No newline at end of file diff --git a/docs/models/badgatewayresponseerrordata.mdx b/docs/models/badgatewayresponseerrordata.mdx index a2e1c40a7..c6f2245e8 100644 --- a/docs/models/badgatewayresponseerrordata.mdx +++ b/docs/models/badgatewayresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: BadGatewayResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/badrequestresponseerrordata.mdx b/docs/models/badrequestresponseerrordata.mdx index df661d9c7..9dae0b3d9 100644 --- a/docs/models/badrequestresponseerrordata.mdx +++ b/docs/models/badrequestresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: BadRequestResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/baseinputsmessage.mdx b/docs/models/baseinputsmessage.mdx index 038c4cf43..d73decf77 100644 --- a/docs/models/baseinputsmessage.mdx +++ b/docs/models/baseinputsmessage.mdx @@ -17,7 +17,7 @@ let value: BaseInputsMessage = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `content` | *models.BaseInputsContent2* | :heavy_check_mark: | N/A | -| `phase` | *models.BaseInputsPhaseUnion* | :heavy_minus_sign: | N/A | -| `role` | *models.BaseInputsRoleUnion* | :heavy_check_mark: | N/A | -| `type` | [models.BaseInputsType](../models/baseinputstype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | *models.BaseInputsContent2* | ✅ | N/A | +| `phase` | *models.BaseInputsPhaseUnion* | ➖ | N/A | +| `role` | *models.BaseInputsRoleUnion* | ✅ | N/A | +| `type` | [models.BaseInputsType](../models/baseinputstype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/basereasoningconfig.mdx b/docs/models/basereasoningconfig.mdx index c5afabb00..a056fff65 100644 --- a/docs/models/basereasoningconfig.mdx +++ b/docs/models/basereasoningconfig.mdx @@ -14,7 +14,7 @@ let value: BaseReasoningConfig = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context` | [models.ReasoningContext](../models/reasoningcontext.mdx) | :heavy_minus_sign: | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | -| `effort` | [models.ReasoningEffort](../models/reasoningeffort.mdx) | :heavy_minus_sign: | N/A | medium | -| `mode` | [models.ReasoningMode](../models/reasoningmode.mdx) | :heavy_minus_sign: | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | -| `summary` | [models.ReasoningSummaryVerbosity](../models/reasoningsummaryverbosity.mdx) | :heavy_minus_sign: | N/A | auto | \ No newline at end of file +| `context` | [models.ReasoningContext](../models/reasoningcontext.mdx) | ➖ | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | +| `effort` | [models.ReasoningEffort](../models/reasoningeffort.mdx) | ➖ | N/A | medium | +| `mode` | [models.ReasoningMode](../models/reasoningmode.mdx) | ➖ | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | +| `summary` | [models.ReasoningSummaryVerbosity](../models/reasoningsummaryverbosity.mdx) | ➖ | N/A | auto | \ No newline at end of file diff --git a/docs/models/bashservertool.mdx b/docs/models/bashservertool.mdx index 1bee23e8f..4f6863caf 100644 --- a/docs/models/bashservertool.mdx +++ b/docs/models/bashservertool.mdx @@ -18,5 +18,5 @@ let value: BashServerTool = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `parameters` | [models.BashServerToolConfig](../models/bashservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | -| `type` | [models.BashServerToolType](../models/bashservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.BashServerToolConfig](../models/bashservertoolconfig.mdx) | ➖ | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | +| `type` | [models.BashServerToolType](../models/bashservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/bashservertoolconfig.mdx b/docs/models/bashservertoolconfig.mdx index ae3566311..7a8c5fdcd 100644 --- a/docs/models/bashservertoolconfig.mdx +++ b/docs/models/bashservertoolconfig.mdx @@ -16,5 +16,5 @@ let value: BashServerToolConfig = {}; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `engine` | [models.BashServerToolEngine](../models/bashservertoolengine.mdx) | :heavy_minus_sign: | Which bash engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) and "native" use native passthrough, returning the tool call to your application to run client-side; OpenRouter does not execute the commands. | auto | -| `environment` | *models.BashServerToolEnvironment* | :heavy_minus_sign: | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | \ No newline at end of file +| `engine` | [models.BashServerToolEngine](../models/bashservertoolengine.mdx) | ➖ | Which bash engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) and "native" use native passthrough, returning the tool call to your application to run client-side; OpenRouter does not execute the commands. | auto | +| `environment` | *models.BashServerToolEnvironment* | ➖ | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | \ No newline at end of file diff --git a/docs/models/batchdeletedobject.mdx b/docs/models/batchdeletedobject.mdx index 45d5fd1e6..5ccb67883 100644 --- a/docs/models/batchdeletedobject.mdx +++ b/docs/models/batchdeletedobject.mdx @@ -22,6 +22,6 @@ let value: BatchDeletedObject = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `deletion` | [models.BatchDeletionTargets](../models/batchdeletiontargets.mdx) | :heavy_check_mark: | OpenRouter cleanup and, when a provider was assigned, the upstream batch deletion outcome. | \{
"openrouter": "deleted",
"upstream": \{
"provider": "Anthropic",
"status": "deleted"
}
} | -| `id` | *string* | :heavy_check_mark: | N/A | batch_abc123 | -| `object` | [models.BatchDeletedObjectObject](../models/batchdeletedobjectobject.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `deletion` | [models.BatchDeletionTargets](../models/batchdeletiontargets.mdx) | ✅ | OpenRouter cleanup and, when a provider was assigned, the upstream batch deletion outcome. | \{
"openrouter": "deleted",
"upstream": \{
"provider": "Anthropic",
"status": "deleted"
}
} | +| `id` | *string* | ✅ | N/A | batch_abc123 | +| `object` | [models.BatchDeletedObjectObject](../models/batchdeletedobjectobject.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/batchdeletiontargets.mdx b/docs/models/batchdeletiontargets.mdx index 952196ec9..96dd1db25 100644 --- a/docs/models/batchdeletiontargets.mdx +++ b/docs/models/batchdeletiontargets.mdx @@ -18,5 +18,5 @@ let value: BatchDeletionTargets = { | Field | Type | Required | Description | | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `openrouter` | [models.Openrouter](../models/openrouter.mdx) | :heavy_check_mark: | OpenRouter-held request and result artifacts were purged. | -| `upstream` | [models.Upstream](../models/upstream.mdx) | :heavy_minus_sign: | The upstream batch deletion outcome; omitted when no provider was assigned. | \ No newline at end of file +| `openrouter` | [models.Openrouter](../models/openrouter.mdx) | ✅ | OpenRouter-held request and result artifacts were purged. | +| `upstream` | [models.Upstream](../models/upstream.mdx) | ➖ | The upstream batch deletion outcome; omitted when no provider was assigned. | \ No newline at end of file diff --git a/docs/models/batcherrorresponseerror.mdx b/docs/models/batcherrorresponseerror.mdx index a12aad15c..3f5dd5523 100644 --- a/docs/models/batcherrorresponseerror.mdx +++ b/docs/models/batcherrorresponseerror.mdx @@ -17,5 +17,5 @@ let value: BatchErrorResponseError = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchlistitem.mdx b/docs/models/batchlistitem.mdx index 76a521fd4..b412ecf5e 100644 --- a/docs/models/batchlistitem.mdx +++ b/docs/models/batchlistitem.mdx @@ -39,15 +39,15 @@ let value: BatchListItem = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `completionWindow` | [models.BatchListItemCompletionWindow](../models/batchlistitemcompletionwindow.mdx) | :heavy_check_mark: | N/A | -| `createdAt` | *number* | :heavy_check_mark: | N/A | -| `endpoint` | *string* | :heavy_check_mark: | N/A | -| `error` | [models.BatchListItemError](../models/batchlistitemerror.mdx) | :heavy_check_mark: | N/A | -| `finalizedAt` | *number* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.BatchListItemObject](../models/batchlistitemobject.mdx) | :heavy_check_mark: | N/A | -| `requestCounts` | [models.BatchListItemRequestCounts](../models/batchlistitemrequestcounts.mdx) | :heavy_check_mark: | N/A | -| `results` | *any* | :heavy_check_mark: | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | -| `status` | [models.BatchListItemStatus](../models/batchlistitemstatus.mdx) | :heavy_check_mark: | N/A | -| `usage` | [models.BatchListItemUsage](../models/batchlistitemusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `completionWindow` | [models.BatchListItemCompletionWindow](../models/batchlistitemcompletionwindow.mdx) | ✅ | N/A | +| `createdAt` | *number* | ✅ | N/A | +| `endpoint` | *string* | ✅ | N/A | +| `error` | [models.BatchListItemError](../models/batchlistitemerror.mdx) | ✅ | N/A | +| `finalizedAt` | *number* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `model` | *string* | ✅ | N/A | +| `object` | [models.BatchListItemObject](../models/batchlistitemobject.mdx) | ✅ | N/A | +| `requestCounts` | [models.BatchListItemRequestCounts](../models/batchlistitemrequestcounts.mdx) | ✅ | N/A | +| `results` | *any* | ✅ | Always null: retrieve the batch with `GET /batches/{id}` to access its results. | +| `status` | [models.BatchListItemStatus](../models/batchlistitemstatus.mdx) | ✅ | N/A | +| `usage` | [models.BatchListItemUsage](../models/batchlistitemusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchlistitemcompletiontokensdetails.mdx b/docs/models/batchlistitemcompletiontokensdetails.mdx index 3b2bc2b4f..0f18e21ca 100644 --- a/docs/models/batchlistitemcompletiontokensdetails.mdx +++ b/docs/models/batchlistitemcompletiontokensdetails.mdx @@ -14,6 +14,6 @@ let value: BatchListItemCompletionTokensDetails = {}; | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `imageTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoningTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens generated by the model for audio output. | +| `imageTokens` | *number* | ➖ | Tokens generated by the model for image output. | +| `reasoningTokens` | *number* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/batchlistitemerror.mdx b/docs/models/batchlistitemerror.mdx index 4ed49094d..7b0e2e2a3 100644 --- a/docs/models/batchlistitemerror.mdx +++ b/docs/models/batchlistitemerror.mdx @@ -16,4 +16,4 @@ let value: BatchListItemError = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `message` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchlistitemprompttokensdetails.mdx b/docs/models/batchlistitemprompttokensdetails.mdx index 8e7119e4e..19b0342bb 100644 --- a/docs/models/batchlistitemprompttokensdetails.mdx +++ b/docs/models/batchlistitemprompttokensdetails.mdx @@ -16,8 +16,8 @@ let value: BatchListItemPromptTokensDetails = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens used for input audio. | -| `cacheWriteTokens` | *number* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cachedTokens` | *number* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `fileTokens` | *number* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `videoTokens` | *number* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens used for input audio. | +| `cacheWriteTokens` | *number* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cachedTokens` | *number* | ➖ | Tokens cached by the endpoint. | +| `fileTokens` | *number* | ➖ | Tokens used for input files/documents. | +| `videoTokens` | *number* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/batchlistitemrequestcounts.mdx b/docs/models/batchlistitemrequestcounts.mdx index d629f5d54..81a6a9130 100644 --- a/docs/models/batchlistitemrequestcounts.mdx +++ b/docs/models/batchlistitemrequestcounts.mdx @@ -18,6 +18,6 @@ let value: BatchListItemRequestCounts = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `completed` | *number* | :heavy_check_mark: | N/A | -| `failed` | *number* | :heavy_check_mark: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `completed` | *number* | ✅ | N/A | +| `failed` | *number* | ✅ | N/A | +| `total` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchlistitemservertooluse.mdx b/docs/models/batchlistitemservertooluse.mdx index a7a5fddd3..5558eaee8 100644 --- a/docs/models/batchlistitemservertooluse.mdx +++ b/docs/models/batchlistitemservertooluse.mdx @@ -16,6 +16,6 @@ let value: BatchListItemServerToolUse = {}; | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `toolCallsExecuted` | *number* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `toolCallsRequested` | *number* | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `webSearchRequests` | *number* | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `toolCallsExecuted` | *number* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `toolCallsRequested` | *number* | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `webSearchRequests` | *number* | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/batchlistitemusage.mdx b/docs/models/batchlistitemusage.mdx index f55b50c6b..c5c4ff933 100644 --- a/docs/models/batchlistitemusage.mdx +++ b/docs/models/batchlistitemusage.mdx @@ -18,16 +18,16 @@ let value: BatchListItemUsage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completionTokens` | *number* | :heavy_check_mark: | The tokens generated | | -| `completionTokensDetails` | [models.BatchListItemCompletionTokensDetails](../models/batchlistitemcompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | -| `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | *models.AnthropicUsageIteration*[] | :heavy_minus_sign: | N/A | | -| `promptTokens` | *number* | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `promptTokensDetails` | [models.BatchListItemPromptTokensDetails](../models/batchlistitemprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `serverToolUse` | [models.BatchListItemServerToolUse](../models/batchlistitemservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `serviceTier` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | -| `totalTokens` | *number* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completionTokens` | *number* | ✅ | The tokens generated | | +| `completionTokensDetails` | [models.BatchListItemCompletionTokensDetails](../models/batchlistitemcompletiontokensdetails.mdx) | ➖ | N/A | | +| `cost` | *number* | ➖ | Cost of the completion | | +| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `isByok` | *boolean* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | *models.AnthropicUsageIteration*[] | ➖ | N/A | | +| `promptTokens` | *number* | ✅ | Including images, input audio, and tools if any | | +| `promptTokensDetails` | [models.BatchListItemPromptTokensDetails](../models/batchlistitemprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | +| `serverToolUse` | [models.BatchListItemServerToolUse](../models/batchlistitemservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `serviceTier` | *string* | ➖ | The service tier used by the upstream provider for this request | | +| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | ➖ | N/A | standard | +| `totalTokens` | *number* | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/batchlistresponse.mdx b/docs/models/batchlistresponse.mdx index d2f407d36..927bf76e2 100644 --- a/docs/models/batchlistresponse.mdx +++ b/docs/models/batchlistresponse.mdx @@ -22,8 +22,8 @@ let value: BatchListResponse = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [models.BatchListItem](../models/batchlistitem.mdx)[] | :heavy_check_mark: | N/A | -| `firstId` | *string* | :heavy_check_mark: | N/A | -| `hasMore` | *boolean* | :heavy_check_mark: | N/A | -| `lastId` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.BatchListResponseObject](../models/batchlistresponseobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.BatchListItem](../models/batchlistitem.mdx)[] | ✅ | N/A | +| `firstId` | *string* | ✅ | N/A | +| `hasMore` | *boolean* | ✅ | N/A | +| `lastId` | *string* | ✅ | N/A | +| `object` | [models.BatchListResponseObject](../models/batchlistresponseobject.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchobject.mdx b/docs/models/batchobject.mdx index fa86b627a..69afea6a0 100644 --- a/docs/models/batchobject.mdx +++ b/docs/models/batchobject.mdx @@ -83,15 +83,15 @@ let value: BatchObject = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `completionWindow` | [models.BatchObjectCompletionWindow](../models/batchobjectcompletionwindow.mdx) | :heavy_check_mark: | N/A | -| `createdAt` | *number* | :heavy_check_mark: | N/A | -| `endpoint` | *string* | :heavy_check_mark: | N/A | -| `error` | [models.BatchObjectError](../models/batchobjecterror.mdx) | :heavy_check_mark: | N/A | -| `finalizedAt` | *number* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.BatchObjectObjectBatch](../models/batchobjectobjectbatch.mdx) | :heavy_check_mark: | N/A | -| `requestCounts` | [models.BatchObjectRequestCounts](../models/batchobjectrequestcounts.mdx) | :heavy_check_mark: | N/A | -| `results` | [models.Result](../models/result.mdx)[] | :heavy_check_mark: | N/A | -| `status` | [models.BatchObjectStatus](../models/batchobjectstatus.mdx) | :heavy_check_mark: | N/A | -| `usage` | [models.BatchObjectUsage](../models/batchobjectusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `completionWindow` | [models.BatchObjectCompletionWindow](../models/batchobjectcompletionwindow.mdx) | ✅ | N/A | +| `createdAt` | *number* | ✅ | N/A | +| `endpoint` | *string* | ✅ | N/A | +| `error` | [models.BatchObjectError](../models/batchobjecterror.mdx) | ✅ | N/A | +| `finalizedAt` | *number* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `model` | *string* | ✅ | N/A | +| `object` | [models.BatchObjectObjectBatch](../models/batchobjectobjectbatch.mdx) | ✅ | N/A | +| `requestCounts` | [models.BatchObjectRequestCounts](../models/batchobjectrequestcounts.mdx) | ✅ | N/A | +| `results` | [models.Result](../models/result.mdx)[] | ✅ | N/A | +| `status` | [models.BatchObjectStatus](../models/batchobjectstatus.mdx) | ✅ | N/A | +| `usage` | [models.BatchObjectUsage](../models/batchobjectusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjectcompletiontokensdetails.mdx b/docs/models/batchobjectcompletiontokensdetails.mdx index 11de4dd57..7a6d6a954 100644 --- a/docs/models/batchobjectcompletiontokensdetails.mdx +++ b/docs/models/batchobjectcompletiontokensdetails.mdx @@ -14,6 +14,6 @@ let value: BatchObjectCompletionTokensDetails = {}; | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `imageTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoningTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens generated by the model for audio output. | +| `imageTokens` | *number* | ➖ | Tokens generated by the model for image output. | +| `reasoningTokens` | *number* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/batchobjectdata.mdx b/docs/models/batchobjectdata.mdx index c42c0e206..f5da36612 100644 --- a/docs/models/batchobjectdata.mdx +++ b/docs/models/batchobjectdata.mdx @@ -23,6 +23,6 @@ let value: BatchObjectData = { | Field | Type | Required | Description | Example | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `embedding` | *models.Embedding* | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `index` | *number* | :heavy_minus_sign: | Index of the embedding in the input list | 0 | -| `object` | [models.ObjectEmbedding](../models/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `embedding` | *models.Embedding* | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `index` | *number* | ➖ | Index of the embedding in the input list | 0 | +| `object` | [models.ObjectEmbedding](../models/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/batchobjectdebug.mdx b/docs/models/batchobjectdebug.mdx index 602a00d55..1db6450c5 100644 --- a/docs/models/batchobjectdebug.mdx +++ b/docs/models/batchobjectdebug.mdx @@ -14,6 +14,6 @@ let value: BatchObjectDebug = {}; | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `echoUpstreamBody` | Record\ | :heavy_minus_sign: | N/A | -| `timings` | [models.BatchObjectTimings](../models/batchobjecttimings.mdx) | :heavy_minus_sign: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `echoUpstreamBody` | Record\ | ➖ | N/A | +| `timings` | [models.BatchObjectTimings](../models/batchobjecttimings.mdx) | ➖ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjecterror.mdx b/docs/models/batchobjecterror.mdx index cb908988e..3a45d1efa 100644 --- a/docs/models/batchobjecterror.mdx +++ b/docs/models/batchobjecterror.mdx @@ -16,4 +16,4 @@ let value: BatchObjectError = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `message` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjectfile.mdx b/docs/models/batchobjectfile.mdx index eb9510fba..62c8e506a 100644 --- a/docs/models/batchobjectfile.mdx +++ b/docs/models/batchobjectfile.mdx @@ -24,6 +24,6 @@ let value: BatchObjectFile = { | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `content` | *models.AnnotationContentUnion*[] | :heavy_check_mark: | N/A | -| `hash` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | *models.AnnotationContentUnion*[] | ✅ | N/A | +| `hash` | *string* | ✅ | N/A | +| `name` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjectfunction.mdx b/docs/models/batchobjectfunction.mdx index f9b030054..59ed12e09 100644 --- a/docs/models/batchobjectfunction.mdx +++ b/docs/models/batchobjectfunction.mdx @@ -17,5 +17,5 @@ let value: BatchObjectFunction = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | +| `name` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjectimageurl.mdx b/docs/models/batchobjectimageurl.mdx index a747c2b3e..2417a2ce4 100644 --- a/docs/models/batchobjectimageurl.mdx +++ b/docs/models/batchobjectimageurl.mdx @@ -16,4 +16,4 @@ let value: BatchObjectImageUrl = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjectprompttokensdetails.mdx b/docs/models/batchobjectprompttokensdetails.mdx index 41118dcf3..1c8817c9d 100644 --- a/docs/models/batchobjectprompttokensdetails.mdx +++ b/docs/models/batchobjectprompttokensdetails.mdx @@ -16,8 +16,8 @@ let value: BatchObjectPromptTokensDetails = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens used for input audio. | -| `cacheWriteTokens` | *number* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cachedTokens` | *number* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `fileTokens` | *number* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `videoTokens` | *number* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens used for input audio. | +| `cacheWriteTokens` | *number* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cachedTokens` | *number* | ➖ | Tokens cached by the endpoint. | +| `fileTokens` | *number* | ➖ | Tokens used for input files/documents. | +| `videoTokens` | *number* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/batchobjectrequestcounts.mdx b/docs/models/batchobjectrequestcounts.mdx index 7adf623db..9d7616a10 100644 --- a/docs/models/batchobjectrequestcounts.mdx +++ b/docs/models/batchobjectrequestcounts.mdx @@ -18,6 +18,6 @@ let value: BatchObjectRequestCounts = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `completed` | *number* | :heavy_check_mark: | N/A | -| `failed` | *number* | :heavy_check_mark: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `completed` | *number* | ✅ | N/A | +| `failed` | *number* | ✅ | N/A | +| `total` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjectresponse.mdx b/docs/models/batchobjectresponse.mdx index fc24db93f..1f2477cc4 100644 --- a/docs/models/batchobjectresponse.mdx +++ b/docs/models/batchobjectresponse.mdx @@ -49,6 +49,6 @@ let value: BatchObjectResponse = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `body` | *models.Body* | :heavy_check_mark: | N/A | -| `requestId` | *string* | :heavy_check_mark: | N/A | -| `statusCode` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `body` | *models.Body* | ✅ | N/A | +| `requestId` | *string* | ✅ | N/A | +| `statusCode` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjectservertooluse.mdx b/docs/models/batchobjectservertooluse.mdx index 5fbfec252..e0989ffe3 100644 --- a/docs/models/batchobjectservertooluse.mdx +++ b/docs/models/batchobjectservertooluse.mdx @@ -16,6 +16,6 @@ let value: BatchObjectServerToolUse = {}; | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `toolCallsExecuted` | *number* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `toolCallsRequested` | *number* | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `webSearchRequests` | *number* | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `toolCallsExecuted` | *number* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `toolCallsRequested` | *number* | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `webSearchRequests` | *number* | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/batchobjectservertoolusedetails.mdx b/docs/models/batchobjectservertoolusedetails.mdx index 6a4fba931..3b91a1e0f 100644 --- a/docs/models/batchobjectservertoolusedetails.mdx +++ b/docs/models/batchobjectservertoolusedetails.mdx @@ -16,6 +16,6 @@ let value: BatchObjectServerToolUseDetails = {}; | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `toolCallsExecuted` | *number* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `toolCallsRequested` | *number* | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `webSearchRequests` | *number* | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `toolCallsExecuted` | *number* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `toolCallsRequested` | *number* | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `webSearchRequests` | *number* | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/batchobjecttimings.mdx b/docs/models/batchobjecttimings.mdx index c3b9cf662..94ee10a31 100644 --- a/docs/models/batchobjecttimings.mdx +++ b/docs/models/batchobjecttimings.mdx @@ -18,6 +18,6 @@ let value: BatchObjectTimings = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `epochMs` | *number* | :heavy_check_mark: | N/A | -| `event` | [models.BatchObjectEvent](../models/batchobjectevent.mdx) | :heavy_check_mark: | N/A | -| `startMs` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `epochMs` | *number* | ✅ | N/A | +| `event` | [models.BatchObjectEvent](../models/batchobjectevent.mdx) | ✅ | N/A | +| `startMs` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjecturlcitation.mdx b/docs/models/batchobjecturlcitation.mdx index 828e9f10a..030a80215 100644 --- a/docs/models/batchobjecturlcitation.mdx +++ b/docs/models/batchobjecturlcitation.mdx @@ -19,8 +19,8 @@ let value: BatchObjectUrlCitation = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `content` | *string* | :heavy_minus_sign: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *string* | ➖ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `title` | *string* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchobjectusage.mdx b/docs/models/batchobjectusage.mdx index bdb3cecd3..6c0c1e556 100644 --- a/docs/models/batchobjectusage.mdx +++ b/docs/models/batchobjectusage.mdx @@ -18,16 +18,16 @@ let value: BatchObjectUsage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completionTokens` | *number* | :heavy_check_mark: | The tokens generated | | -| `completionTokensDetails` | [models.BatchObjectCompletionTokensDetails](../models/batchobjectcompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | -| `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | *models.AnthropicUsageIteration*[] | :heavy_minus_sign: | N/A | | -| `promptTokens` | *number* | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `promptTokensDetails` | [models.BatchObjectPromptTokensDetails](../models/batchobjectprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `serverToolUse` | [models.BatchObjectServerToolUse](../models/batchobjectservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `serviceTier` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | -| `totalTokens` | *number* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completionTokens` | *number* | ✅ | The tokens generated | | +| `completionTokensDetails` | [models.BatchObjectCompletionTokensDetails](../models/batchobjectcompletiontokensdetails.mdx) | ➖ | N/A | | +| `cost` | *number* | ➖ | Cost of the completion | | +| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `isByok` | *boolean* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | *models.AnthropicUsageIteration*[] | ➖ | N/A | | +| `promptTokens` | *number* | ✅ | Including images, input audio, and tools if any | | +| `promptTokensDetails` | [models.BatchObjectPromptTokensDetails](../models/batchobjectprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | +| `serverToolUse` | [models.BatchObjectServerToolUse](../models/batchobjectservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `serviceTier` | *string* | ➖ | The service tier used by the upstream provider for this request | | +| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | ➖ | N/A | standard | +| `totalTokens` | *number* | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/batchpaymentrequiredresponsecompletiontokensdetails.mdx b/docs/models/batchpaymentrequiredresponsecompletiontokensdetails.mdx index b35744787..a1908309c 100644 --- a/docs/models/batchpaymentrequiredresponsecompletiontokensdetails.mdx +++ b/docs/models/batchpaymentrequiredresponsecompletiontokensdetails.mdx @@ -14,6 +14,6 @@ let value: BatchPaymentRequiredResponseCompletionTokensDetails = {}; | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `imageTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoningTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens generated by the model for audio output. | +| `imageTokens` | *number* | ➖ | Tokens generated by the model for image output. | +| `reasoningTokens` | *number* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/batchpaymentrequiredresponseerror.mdx b/docs/models/batchpaymentrequiredresponseerror.mdx index 35b873041..78327d8d0 100644 --- a/docs/models/batchpaymentrequiredresponseerror.mdx +++ b/docs/models/batchpaymentrequiredresponseerror.mdx @@ -17,5 +17,5 @@ let value: BatchPaymentRequiredResponseError = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchpaymentrequiredresponseprompttokensdetails.mdx b/docs/models/batchpaymentrequiredresponseprompttokensdetails.mdx index ff0c2459f..4e3b9cf27 100644 --- a/docs/models/batchpaymentrequiredresponseprompttokensdetails.mdx +++ b/docs/models/batchpaymentrequiredresponseprompttokensdetails.mdx @@ -16,8 +16,8 @@ let value: BatchPaymentRequiredResponsePromptTokensDetails = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens used for input audio. | -| `cacheWriteTokens` | *number* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cachedTokens` | *number* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `fileTokens` | *number* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `videoTokens` | *number* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens used for input audio. | +| `cacheWriteTokens` | *number* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cachedTokens` | *number* | ➖ | Tokens cached by the endpoint. | +| `fileTokens` | *number* | ➖ | Tokens used for input files/documents. | +| `videoTokens` | *number* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/batchpaymentrequiredresponserequestcounts.mdx b/docs/models/batchpaymentrequiredresponserequestcounts.mdx index 72d4a797d..11ac45d7d 100644 --- a/docs/models/batchpaymentrequiredresponserequestcounts.mdx +++ b/docs/models/batchpaymentrequiredresponserequestcounts.mdx @@ -18,6 +18,6 @@ let value: BatchPaymentRequiredResponseRequestCounts = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `completed` | *number* | :heavy_check_mark: | N/A | -| `failed` | *number* | :heavy_check_mark: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `completed` | *number* | ✅ | N/A | +| `failed` | *number* | ✅ | N/A | +| `total` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/batchpaymentrequiredresponseservertooluse.mdx b/docs/models/batchpaymentrequiredresponseservertooluse.mdx index 56a87f0ec..dbd8a47a0 100644 --- a/docs/models/batchpaymentrequiredresponseservertooluse.mdx +++ b/docs/models/batchpaymentrequiredresponseservertooluse.mdx @@ -16,6 +16,6 @@ let value: BatchPaymentRequiredResponseServerToolUse = {}; | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `toolCallsExecuted` | *number* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `toolCallsRequested` | *number* | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `webSearchRequests` | *number* | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `toolCallsExecuted` | *number* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `toolCallsRequested` | *number* | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `webSearchRequests` | *number* | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/batchpaymentrequiredresponseusage.mdx b/docs/models/batchpaymentrequiredresponseusage.mdx index e6cb27126..c1f0edaaa 100644 --- a/docs/models/batchpaymentrequiredresponseusage.mdx +++ b/docs/models/batchpaymentrequiredresponseusage.mdx @@ -18,16 +18,16 @@ let value: BatchPaymentRequiredResponseUsage = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completionTokens` | *number* | :heavy_check_mark: | The tokens generated | | -| `completionTokensDetails` | [models.BatchPaymentRequiredResponseCompletionTokensDetails](../models/batchpaymentrequiredresponsecompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | -| `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | *models.AnthropicUsageIteration*[] | :heavy_minus_sign: | N/A | | -| `promptTokens` | *number* | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `promptTokensDetails` | [models.BatchPaymentRequiredResponsePromptTokensDetails](../models/batchpaymentrequiredresponseprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `serverToolUse` | [models.BatchPaymentRequiredResponseServerToolUse](../models/batchpaymentrequiredresponseservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `serviceTier` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | -| `totalTokens` | *number* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completionTokens` | *number* | ✅ | The tokens generated | | +| `completionTokensDetails` | [models.BatchPaymentRequiredResponseCompletionTokensDetails](../models/batchpaymentrequiredresponsecompletiontokensdetails.mdx) | ➖ | N/A | | +| `cost` | *number* | ➖ | Cost of the completion | | +| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `isByok` | *boolean* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | *models.AnthropicUsageIteration*[] | ➖ | N/A | | +| `promptTokens` | *number* | ✅ | Including images, input audio, and tools if any | | +| `promptTokensDetails` | [models.BatchPaymentRequiredResponsePromptTokensDetails](../models/batchpaymentrequiredresponseprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | +| `serverToolUse` | [models.BatchPaymentRequiredResponseServerToolUse](../models/batchpaymentrequiredresponseservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `serviceTier` | *string* | ➖ | The service tier used by the upstream provider for this request | | +| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | ➖ | N/A | standard | +| `totalTokens` | *number* | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/batchproviderpreferences.mdx b/docs/models/batchproviderpreferences.mdx index 827d98835..9ebc39e29 100644 --- a/docs/models/batchproviderpreferences.mdx +++ b/docs/models/batchproviderpreferences.mdx @@ -16,5 +16,5 @@ let value: BatchProviderPreferences = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowFallbacks` | *boolean* | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `only` | *models.BatchProviderPreferencesOnly*[] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | \ No newline at end of file +| `allowFallbacks` | *boolean* | ➖ | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | +| `only` | *models.BatchProviderPreferencesOnly*[] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | \ No newline at end of file diff --git a/docs/models/batchsubmitbody.mdx b/docs/models/batchsubmitbody.mdx index 638dab762..dc06f57e9 100644 --- a/docs/models/batchsubmitbody.mdx +++ b/docs/models/batchsubmitbody.mdx @@ -20,8 +20,8 @@ let value: BatchSubmitBody = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `completionWindow` | [models.BatchSubmitBodyCompletionWindow](../models/batchsubmitbodycompletionwindow.mdx) | :heavy_minus_sign: | N/A | | -| `endpoint` | [models.Endpoint](../models/endpoint.mdx) | :heavy_check_mark: | N/A | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `provider` | [models.BatchProviderPreferences](../models/batchproviderpreferences.mdx) | :heavy_minus_sign: | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | -| `requests` | [models.RequestT](../models/requestt.mdx)[] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `completionWindow` | [models.BatchSubmitBodyCompletionWindow](../models/batchsubmitbodycompletionwindow.mdx) | ➖ | N/A | | +| `endpoint` | [models.Endpoint](../models/endpoint.mdx) | ✅ | N/A | | +| `model` | *string* | ✅ | N/A | | +| `provider` | [models.BatchProviderPreferences](../models/batchproviderpreferences.mdx) | ➖ | Batch provider routing preferences. Only `provider.only` and `provider.allow_fallbacks` are supported. | \{
"only": [
"google-vertex"
]
} | +| `requests` | [models.RequestT](../models/requestt.mdx)[] | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/bodychatcompletion.mdx b/docs/models/bodychatcompletion.mdx index d127dcc24..406aa2712 100644 --- a/docs/models/bodychatcompletion.mdx +++ b/docs/models/bodychatcompletion.mdx @@ -41,15 +41,15 @@ let value: BodyChatCompletion = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alignment` | [models.Alignment](../models/alignment.mdx) | :heavy_minus_sign: | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | -| `choices` | [models.Choice](../models/choice.mdx)[] | :heavy_check_mark: | N/A | | -| `created` | *number* | :heavy_check_mark: | N/A | | -| `debug` | [models.BatchObjectDebug](../models/batchobjectdebug.mdx) | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `object` | [models.BodyObjectChatCompletion](../models/bodyobjectchatcompletion.mdx) | :heavy_check_mark: | N/A | | -| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | -| `provider` | *string* | :heavy_minus_sign: | N/A | | -| `serviceTier` | *string* | :heavy_minus_sign: | N/A | | -| `systemFingerprint` | *string* | :heavy_minus_sign: | N/A | | -| `usage` | [models.BodyUsage1](../models/bodyusage1.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `alignment` | [models.Alignment](../models/alignment.mdx) | ➖ | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | +| `choices` | [models.Choice](../models/choice.mdx)[] | ✅ | N/A | | +| `created` | *number* | ✅ | N/A | | +| `debug` | [models.BatchObjectDebug](../models/batchobjectdebug.mdx) | ➖ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `model` | *string* | ✅ | N/A | | +| `object` | [models.BodyObjectChatCompletion](../models/bodyobjectchatcompletion.mdx) | ✅ | N/A | | +| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `provider` | *string* | ➖ | N/A | | +| `serviceTier` | *string* | ➖ | N/A | | +| `systemFingerprint` | *string* | ➖ | N/A | | +| `usage` | [models.BodyUsage1](../models/bodyusage1.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/bodycompletiontokensdetails.mdx b/docs/models/bodycompletiontokensdetails.mdx index 20ce8aebd..477470fb8 100644 --- a/docs/models/bodycompletiontokensdetails.mdx +++ b/docs/models/bodycompletiontokensdetails.mdx @@ -14,6 +14,6 @@ let value: BodyCompletionTokensDetails = {}; | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `imageTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoningTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens generated by the model for audio output. | +| `imageTokens` | *number* | ➖ | Tokens generated by the model for image output. | +| `reasoningTokens` | *number* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/bodylist.mdx b/docs/models/bodylist.mdx index f3b790ea1..41259c993 100644 --- a/docs/models/bodylist.mdx +++ b/docs/models/bodylist.mdx @@ -29,8 +29,8 @@ let value: BodyList = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | [models.BatchObjectData](../models/batchobjectdata.mdx)[] | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `id` | *string* | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | -| `model` | *string* | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | -| `object` | [models.BodyObjectList](../models/bodyobjectlist.mdx) | :heavy_check_mark: | N/A | | -| `usage` | [models.BodyUsage3](../models/bodyusage3.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `data` | [models.BatchObjectData](../models/batchobjectdata.mdx)[] | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `id` | *string* | ➖ | Unique identifier for the embeddings response | embd-1234567890 | +| `model` | *string* | ✅ | The model used for embeddings | openai/text-embedding-3-small | +| `object` | [models.BodyObjectList](../models/bodyobjectlist.mdx) | ✅ | N/A | | +| `usage` | [models.BodyUsage3](../models/bodyusage3.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file diff --git a/docs/models/bodymessage.mdx b/docs/models/bodymessage.mdx index c64543a35..eca0baf3f 100644 --- a/docs/models/bodymessage.mdx +++ b/docs/models/bodymessage.mdx @@ -48,14 +48,14 @@ let value: BodyMessage = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `container` | [models.AnthropicContainer](../models/anthropiccontainer.mdx) | :heavy_check_mark: | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | -| `content` | *models.ORAnthropicContentBlock*[] | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `inputTransformations` | [models.AnthropicInputTransformation](../models/anthropicinputtransformation.mdx)[] | :heavy_minus_sign: | N/A | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `role` | [models.BatchObjectRole](../models/batchobjectrole.mdx) | :heavy_check_mark: | N/A | | -| `stopDetails` | [models.AnthropicRefusalStopDetails](../models/anthropicrefusalstopdetails.mdx) | :heavy_check_mark: | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | -| `stopReason` | [models.ORAnthropicStopReason](../models/oranthropicstopreason.mdx) | :heavy_check_mark: | N/A | end_turn | -| `stopSequence` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.BatchObjectTypeMessage](../models/batchobjecttypemessage.mdx) | :heavy_check_mark: | N/A | | -| `usage` | [models.BodyUsage2](../models/bodyusage2.mdx) | :heavy_check_mark: | N/A | \{
"cache_creation": null,
"cache_creation_input_tokens": null,
"cache_read_input_tokens": null,
"inference_geo": null,
"input_tokens": 100,
"output_tokens": 50,
"output_tokens_details": null,
"server_tool_use": null,
"service_tier": "standard"
} | \ No newline at end of file +| `container` | [models.AnthropicContainer](../models/anthropiccontainer.mdx) | ✅ | N/A | \{
"expires_at": "2026-04-08T00:00:00Z",
"id": "ctr_01abc",
"skills": null
} | +| `content` | *models.ORAnthropicContentBlock*[] | ✅ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `inputTransformations` | [models.AnthropicInputTransformation](../models/anthropicinputtransformation.mdx)[] | ➖ | N/A | | +| `model` | *string* | ✅ | N/A | | +| `role` | [models.BatchObjectRole](../models/batchobjectrole.mdx) | ✅ | N/A | | +| `stopDetails` | [models.AnthropicRefusalStopDetails](../models/anthropicrefusalstopdetails.mdx) | ✅ | Structured information about a refusal | \{
"category": "cyber",
"explanation": "The request was refused due to policy.",
"type": "refusal"
} | +| `stopReason` | [models.ORAnthropicStopReason](../models/oranthropicstopreason.mdx) | ✅ | N/A | end_turn | +| `stopSequence` | *string* | ✅ | N/A | | +| `type` | [models.BatchObjectTypeMessage](../models/batchobjecttypemessage.mdx) | ✅ | N/A | | +| `usage` | [models.BodyUsage2](../models/bodyusage2.mdx) | ✅ | N/A | \{
"cache_creation": null,
"cache_creation_input_tokens": null,
"cache_read_input_tokens": null,
"inference_geo": null,
"input_tokens": 100,
"output_tokens": 50,
"output_tokens_details": null,
"server_tool_use": null,
"service_tier": "standard"
} | \ No newline at end of file diff --git a/docs/models/bodyprompttokensdetails1.mdx b/docs/models/bodyprompttokensdetails1.mdx index 5b0ba7034..51e823171 100644 --- a/docs/models/bodyprompttokensdetails1.mdx +++ b/docs/models/bodyprompttokensdetails1.mdx @@ -16,8 +16,8 @@ let value: BodyPromptTokensDetails1 = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens used for input audio. | -| `cacheWriteTokens` | *number* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cachedTokens` | *number* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `fileTokens` | *number* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `videoTokens` | *number* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens used for input audio. | +| `cacheWriteTokens` | *number* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cachedTokens` | *number* | ➖ | Tokens cached by the endpoint. | +| `fileTokens` | *number* | ➖ | Tokens used for input files/documents. | +| `videoTokens` | *number* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/bodyprompttokensdetails2.mdx b/docs/models/bodyprompttokensdetails2.mdx index 1c8b402cf..a9db45834 100644 --- a/docs/models/bodyprompttokensdetails2.mdx +++ b/docs/models/bodyprompttokensdetails2.mdx @@ -16,8 +16,8 @@ let value: BodyPromptTokensDetails2 = {}; | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `audioTokens` | *number* | :heavy_minus_sign: | Number of audio tokens in the input | | -| `fileTokens` | *number* | :heavy_minus_sign: | Number of file/document tokens in the input | | -| `imageTokens` | *number* | :heavy_minus_sign: | Number of image tokens in the input | 258 | -| `textTokens` | *number* | :heavy_minus_sign: | Number of text tokens in the input | 8 | -| `videoTokens` | *number* | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Number of audio tokens in the input | | +| `fileTokens` | *number* | ➖ | Number of file/document tokens in the input | | +| `imageTokens` | *number* | ➖ | Number of image tokens in the input | 258 | +| `textTokens` | *number* | ➖ | Number of text tokens in the input | 8 | +| `videoTokens` | *number* | ➖ | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/models/bodyservertooluse.mdx b/docs/models/bodyservertooluse.mdx index 010d51dee..e8c255851 100644 --- a/docs/models/bodyservertooluse.mdx +++ b/docs/models/bodyservertooluse.mdx @@ -16,6 +16,6 @@ let value: BodyServerToolUse = {}; | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `toolCallsExecuted` | *number* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `toolCallsRequested` | *number* | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `webSearchRequests` | *number* | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `toolCallsExecuted` | *number* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `toolCallsRequested` | *number* | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `webSearchRequests` | *number* | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/bodyusage1.mdx b/docs/models/bodyusage1.mdx index cf36c712b..0f93bac3d 100644 --- a/docs/models/bodyusage1.mdx +++ b/docs/models/bodyusage1.mdx @@ -18,10 +18,10 @@ let value: BodyUsage1 = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `completionTokens` | *number* | :heavy_check_mark: | The tokens generated | -| `completionTokensDetails` | [models.BodyCompletionTokensDetails](../models/bodycompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | -| `promptTokens` | *number* | :heavy_check_mark: | Including images, input audio, and tools if any | -| `promptTokensDetails` | [models.BodyPromptTokensDetails1](../models/bodyprompttokensdetails1.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | -| `serverToolUse` | [models.BodyServerToolUse](../models/bodyservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | -| `serverToolUseDetails` | [models.BatchObjectServerToolUseDetails](../models/batchobjectservertoolusedetails.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | -| `totalTokens` | *number* | :heavy_check_mark: | Sum of the above two fields | \ No newline at end of file +| `completionTokens` | *number* | ✅ | The tokens generated | +| `completionTokensDetails` | [models.BodyCompletionTokensDetails](../models/bodycompletiontokensdetails.mdx) | ➖ | N/A | +| `promptTokens` | *number* | ✅ | Including images, input audio, and tools if any | +| `promptTokensDetails` | [models.BodyPromptTokensDetails1](../models/bodyprompttokensdetails1.mdx) | ➖ | Breakdown of tokens used in the prompt. | +| `serverToolUse` | [models.BodyServerToolUse](../models/bodyservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | +| `serverToolUseDetails` | [models.BatchObjectServerToolUseDetails](../models/batchobjectservertoolusedetails.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | +| `totalTokens` | *number* | ✅ | Sum of the above two fields | \ No newline at end of file diff --git a/docs/models/bodyusage2.mdx b/docs/models/bodyusage2.mdx index fd40d76c5..4e4d6cfb7 100644 --- a/docs/models/bodyusage2.mdx +++ b/docs/models/bodyusage2.mdx @@ -24,14 +24,14 @@ let value: BodyUsage2 = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | :heavy_check_mark: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `cacheCreationInputTokens` | *number* | :heavy_check_mark: | N/A | | -| `cacheReadInputTokens` | *number* | :heavy_check_mark: | N/A | | -| `inferenceGeo` | *string* | :heavy_check_mark: | N/A | | -| `inputTokens` | *number* | :heavy_check_mark: | N/A | | -| `outputTokens` | *number* | :heavy_check_mark: | N/A | | -| `outputTokensDetails` | [models.AnthropicOutputTokensDetails](../models/anthropicoutputtokensdetails.mdx) | :heavy_check_mark: | N/A | \{
"thinking_tokens": 0
} | -| `serverToolUse` | [models.AnthropicServerToolUsage](../models/anthropicservertoolusage.mdx) | :heavy_check_mark: | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | -| `serviceTier` | [models.AnthropicServiceTier](../models/anthropicservicetier.mdx) | :heavy_check_mark: | N/A | standard | -| `iterations` | *models.AnthropicUsageIteration*[] | :heavy_minus_sign: | N/A | | -| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | \ No newline at end of file +| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | ✅ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `cacheCreationInputTokens` | *number* | ✅ | N/A | | +| `cacheReadInputTokens` | *number* | ✅ | N/A | | +| `inferenceGeo` | *string* | ✅ | N/A | | +| `inputTokens` | *number* | ✅ | N/A | | +| `outputTokens` | *number* | ✅ | N/A | | +| `outputTokensDetails` | [models.AnthropicOutputTokensDetails](../models/anthropicoutputtokensdetails.mdx) | ✅ | N/A | \{
"thinking_tokens": 0
} | +| `serverToolUse` | [models.AnthropicServerToolUsage](../models/anthropicservertoolusage.mdx) | ✅ | N/A | \{
"web_fetch_requests": 0,
"web_search_requests": 1
} | +| `serviceTier` | [models.AnthropicServiceTier](../models/anthropicservicetier.mdx) | ✅ | N/A | standard | +| `iterations` | *models.AnthropicUsageIteration*[] | ➖ | N/A | | +| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | ➖ | N/A | standard | \ No newline at end of file diff --git a/docs/models/bodyusage3.mdx b/docs/models/bodyusage3.mdx index 34b21cd14..584fdcd76 100644 --- a/docs/models/bodyusage3.mdx +++ b/docs/models/bodyusage3.mdx @@ -19,9 +19,9 @@ let value: BodyUsage3 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cost` | *number* | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `promptTokens` | *number* | :heavy_check_mark: | Number of tokens in the input | 8 | -| `promptTokensDetails` | [models.BodyPromptTokensDetails2](../models/bodyprompttokensdetails2.mdx) | :heavy_minus_sign: | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | -| `totalTokens` | *number* | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file +| `cost` | *number* | ➖ | Cost of the request in credits | 0.0001 | +| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `isByok` | *boolean* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `promptTokens` | *number* | ✅ | Number of tokens in the input | 8 | +| `promptTokensDetails` | [models.BodyPromptTokensDetails2](../models/bodyprompttokensdetails2.mdx) | ➖ | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | +| `totalTokens` | *number* | ✅ | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/models/booleancapability.mdx b/docs/models/booleancapability.mdx index f9527cd4c..3e3926460 100644 --- a/docs/models/booleancapability.mdx +++ b/docs/models/booleancapability.mdx @@ -18,4 +18,4 @@ let value: BooleanCapability = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"boolean"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"boolean"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/bulkaddworkspacemembersrequest.mdx b/docs/models/bulkaddworkspacemembersrequest.mdx index ecb7080ec..a0cf8e739 100644 --- a/docs/models/bulkaddworkspacemembersrequest.mdx +++ b/docs/models/bulkaddworkspacemembersrequest.mdx @@ -19,4 +19,4 @@ let value: BulkAddWorkspaceMembersRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `userIds` | *string*[] | :heavy_check_mark: | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `userIds` | *string*[] | ✅ | List of user IDs to add to the workspace. Members are assigned the same role they hold in the organization. | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/bulkaddworkspacemembersresponse.mdx b/docs/models/bulkaddworkspacemembersresponse.mdx index 228e96d80..af1fa43f1 100644 --- a/docs/models/bulkaddworkspacemembersresponse.mdx +++ b/docs/models/bulkaddworkspacemembersresponse.mdx @@ -25,5 +25,5 @@ let value: BulkAddWorkspaceMembersResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `addedCount` | *number* | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | -| `data` | [models.WorkspaceMember](../models/workspacemember.mdx)[] | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file +| `addedCount` | *number* | ✅ | Number of workspace memberships created or updated | 2 | +| `data` | [models.WorkspaceMember](../models/workspacemember.mdx)[] | ✅ | List of added workspace memberships | | \ No newline at end of file diff --git a/docs/models/bulkassignkeysrequest.mdx b/docs/models/bulkassignkeysrequest.mdx index e108717de..13f307ae6 100644 --- a/docs/models/bulkassignkeysrequest.mdx +++ b/docs/models/bulkassignkeysrequest.mdx @@ -18,4 +18,4 @@ let value: BulkAssignKeysRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `keyHashes` | *string*[] | :heavy_check_mark: | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `keyHashes` | *string*[] | ✅ | Array of API key hashes to assign to the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/models/bulkassignkeysresponse.mdx b/docs/models/bulkassignkeysresponse.mdx index 810d8e45e..f696d1ef8 100644 --- a/docs/models/bulkassignkeysresponse.mdx +++ b/docs/models/bulkassignkeysresponse.mdx @@ -16,4 +16,4 @@ let value: BulkAssignKeysResponse = { | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `assignedCount` | *number* | :heavy_check_mark: | Number of keys successfully assigned | 3 | \ No newline at end of file +| `assignedCount` | *number* | ✅ | Number of keys successfully assigned | 3 | \ No newline at end of file diff --git a/docs/models/bulkassignmembersrequest.mdx b/docs/models/bulkassignmembersrequest.mdx index 3c6a100e2..fa2256d39 100644 --- a/docs/models/bulkassignmembersrequest.mdx +++ b/docs/models/bulkassignmembersrequest.mdx @@ -19,4 +19,4 @@ let value: BulkAssignMembersRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `memberUserIds` | *string*[] | :heavy_check_mark: | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `memberUserIds` | *string*[] | ✅ | Array of member user IDs to assign to the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/bulkassignmembersresponse.mdx b/docs/models/bulkassignmembersresponse.mdx index 2039feba2..a8ed5ce5c 100644 --- a/docs/models/bulkassignmembersresponse.mdx +++ b/docs/models/bulkassignmembersresponse.mdx @@ -16,4 +16,4 @@ let value: BulkAssignMembersResponse = { | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `assignedCount` | *number* | :heavy_check_mark: | Number of members successfully assigned | 2 | \ No newline at end of file +| `assignedCount` | *number* | ✅ | Number of members successfully assigned | 2 | \ No newline at end of file diff --git a/docs/models/bulkremoveworkspacemembersrequest.mdx b/docs/models/bulkremoveworkspacemembersrequest.mdx index e26dc0742..26b1f6a00 100644 --- a/docs/models/bulkremoveworkspacemembersrequest.mdx +++ b/docs/models/bulkremoveworkspacemembersrequest.mdx @@ -19,4 +19,4 @@ let value: BulkRemoveWorkspaceMembersRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `userIds` | *string*[] | :heavy_check_mark: | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `userIds` | *string*[] | ✅ | List of user IDs to remove from the workspace | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/bulkremoveworkspacemembersresponse.mdx b/docs/models/bulkremoveworkspacemembersresponse.mdx index 1084e1923..c52266bc4 100644 --- a/docs/models/bulkremoveworkspacemembersresponse.mdx +++ b/docs/models/bulkremoveworkspacemembersresponse.mdx @@ -16,4 +16,4 @@ let value: BulkRemoveWorkspaceMembersResponse = { | Field | Type | Required | Description | Example | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `removedCount` | *number* | :heavy_check_mark: | Number of members removed | 2 | \ No newline at end of file +| `removedCount` | *number* | ✅ | Number of members removed | 2 | \ No newline at end of file diff --git a/docs/models/bulkunassignkeysrequest.mdx b/docs/models/bulkunassignkeysrequest.mdx index 6b51ba632..a83c4205c 100644 --- a/docs/models/bulkunassignkeysrequest.mdx +++ b/docs/models/bulkunassignkeysrequest.mdx @@ -18,4 +18,4 @@ let value: BulkUnassignKeysRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `keyHashes` | *string*[] | :heavy_check_mark: | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file +| `keyHashes` | *string*[] | ✅ | Array of API key hashes to unassign from the guardrail | [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
] | \ No newline at end of file diff --git a/docs/models/bulkunassignkeysresponse.mdx b/docs/models/bulkunassignkeysresponse.mdx index fc6ef3018..2d3e39f4c 100644 --- a/docs/models/bulkunassignkeysresponse.mdx +++ b/docs/models/bulkunassignkeysresponse.mdx @@ -16,4 +16,4 @@ let value: BulkUnassignKeysResponse = { | Field | Type | Required | Description | Example | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `unassignedCount` | *number* | :heavy_check_mark: | Number of keys successfully unassigned | 3 | \ No newline at end of file +| `unassignedCount` | *number* | ✅ | Number of keys successfully unassigned | 3 | \ No newline at end of file diff --git a/docs/models/bulkunassignmembersrequest.mdx b/docs/models/bulkunassignmembersrequest.mdx index b50aa71a8..ed4111aa8 100644 --- a/docs/models/bulkunassignmembersrequest.mdx +++ b/docs/models/bulkunassignmembersrequest.mdx @@ -19,4 +19,4 @@ let value: BulkUnassignMembersRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `memberUserIds` | *string*[] | :heavy_check_mark: | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file +| `memberUserIds` | *string*[] | ✅ | Array of member user IDs to unassign from the guardrail | [
"user_abc123",
"user_def456"
] | \ No newline at end of file diff --git a/docs/models/bulkunassignmembersresponse.mdx b/docs/models/bulkunassignmembersresponse.mdx index 60b6940f1..e478431b9 100644 --- a/docs/models/bulkunassignmembersresponse.mdx +++ b/docs/models/bulkunassignmembersresponse.mdx @@ -16,4 +16,4 @@ let value: BulkUnassignMembersResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `unassignedCount` | *number* | :heavy_check_mark: | Number of members successfully unassigned | 2 | \ No newline at end of file +| `unassignedCount` | *number* | ✅ | Number of members successfully unassigned | 2 | \ No newline at end of file diff --git a/docs/models/byokkey.mdx b/docs/models/byokkey.mdx index 91d707e11..5bc53860d 100644 --- a/docs/models/byokkey.mdx +++ b/docs/models/byokkey.mdx @@ -30,19 +30,19 @@ let value: BYOKKey = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedApiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `allowedModels` | *string*[] | :heavy_check_mark: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowedUserIds` | *string*[] | :heavy_check_mark: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | -| `declaredRegion` | [models.BYOKKeyDeclaredRegion](../models/byokkeydeclaredregion.mdx) | :heavy_check_mark: | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. | null | -| `declaredZdr` | *boolean* | :heavy_check_mark: | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. | null | -| `disabled` | *boolean* | :heavy_check_mark: | Whether this credential is currently disabled. | false | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | -| `isByokOnly` | *boolean* | :heavy_check_mark: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. | false | -| `isFallback` | *boolean* | :heavy_check_mark: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | -| `isRequired` | *boolean* | :heavy_check_mark: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. | false | -| `label` | *string* | :heavy_check_mark: | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | -| `name` | *string* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [models.BYOKProviderSlug](../models/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `sortOrder` | *number* | :heavy_check_mark: | Position within the provider — credentials are tried in ascending sort order. | 0 | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace this credential is scoped to, or `null` when it is global — usable across every workspace in the account. A `null` value does not mean the default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `allowedApiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `allowedModels` | *string*[] | ✅ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowedUserIds` | *string*[] | ✅ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `createdAt` | *string* | ✅ | ISO timestamp of when the credential was created. | 2025-08-24T10:30:00Z | +| `declaredRegion` | [models.BYOKKeyDeclaredRegion](../models/byokkeydeclaredregion.mdx) | ✅ | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. | null | +| `declaredZdr` | *boolean* | ✅ | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. | null | +| `disabled` | *boolean* | ✅ | Whether this credential is currently disabled. | false | +| `id` | *string* | ✅ | Stable public identifier for this BYOK credential. | 11111111-2222-3333-4444-555555555555 | +| `isByokOnly` | *boolean* | ✅ | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. | false | +| `isFallback` | *boolean* | ✅ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | +| `isRequired` | *boolean* | ✅ | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. | false | +| `label` | *string* | ✅ | Short masked snippet of the key (e.g. the first/last few characters) used to identify it in the UI. | sk-...AbCd | +| `name` | *string* | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | +| `provider` | [models.BYOKProviderSlug](../models/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `sortOrder` | *number* | ✅ | Position within the provider — credentials are tried in ascending sort order. | 0 | +| `workspaceId` | *string* | ✅ | The workspace this credential is scoped to, or `null` when it is global — usable across every workspace in the account. A `null` value does not mean the default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/chatassistantimages.mdx b/docs/models/chatassistantimages.mdx index f9b051022..cd3b2e41b 100644 --- a/docs/models/chatassistantimages.mdx +++ b/docs/models/chatassistantimages.mdx @@ -18,4 +18,4 @@ let value: ChatAssistantImages = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `imageUrl` | [models.ChatAssistantImagesImageUrl](../models/chatassistantimagesimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [models.ChatAssistantImagesImageUrl](../models/chatassistantimagesimageurl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chatassistantimagesimageurl.mdx b/docs/models/chatassistantimagesimageurl.mdx index 09be264f3..210801756 100644 --- a/docs/models/chatassistantimagesimageurl.mdx +++ b/docs/models/chatassistantimagesimageurl.mdx @@ -16,4 +16,4 @@ let value: ChatAssistantImagesImageUrl = { | Field | Type | Required | Description | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `url` | *string* | :heavy_check_mark: | URL or base64-encoded data of the generated image | \ No newline at end of file +| `url` | *string* | ✅ | URL or base64-encoded data of the generated image | \ No newline at end of file diff --git a/docs/models/chatassistantmessage.mdx b/docs/models/chatassistantmessage.mdx index d2ec5b1e0..a094c38c0 100644 --- a/docs/models/chatassistantmessage.mdx +++ b/docs/models/chatassistantmessage.mdx @@ -18,13 +18,13 @@ let value: ChatAssistantMessage = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [models.ChatAudioOutput](../models/chataudiooutput.mdx) | :heavy_minus_sign: | Audio output data or reference | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | -| `content` | *models.ChatAssistantMessageContent* | :heavy_minus_sign: | Assistant message content | | -| `images` | [models.ChatAssistantImages](../models/chatassistantimages.mdx)[] | :heavy_minus_sign: | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | -| `model` | *string* | :heavy_minus_sign: | Model that generated this assistant message | openai/gpt-4o | -| `name` | *string* | :heavy_minus_sign: | Optional name for the assistant | | -| `reasoning` | *string* | :heavy_minus_sign: | Reasoning output | | -| `reasoningDetails` | *models.ReasoningDetailUnion*[] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | -| `refusal` | *string* | :heavy_minus_sign: | Refusal message if content was refused | | -| `role` | [models.ChatAssistantMessageRole](../models/chatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `toolCalls` | [models.ChatToolCall](../models/chattoolcall.mdx)[] | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file +| `audio` | [models.ChatAudioOutput](../models/chataudiooutput.mdx) | ➖ | Audio output data or reference | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | +| `content` | *models.ChatAssistantMessageContent* | ➖ | Assistant message content | | +| `images` | [models.ChatAssistantImages](../models/chatassistantimages.mdx)[] | ➖ | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | +| `model` | *string* | ➖ | Model that generated this assistant message | openai/gpt-4o | +| `name` | *string* | ➖ | Optional name for the assistant | | +| `reasoning` | *string* | ➖ | Reasoning output | | +| `reasoningDetails` | *models.ReasoningDetailUnion*[] | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | +| `refusal` | *string* | ➖ | Refusal message if content was refused | | +| `role` | [models.ChatAssistantMessageRole](../models/chatassistantmessagerole.mdx) | ✅ | N/A | | +| `toolCalls` | [models.ChatToolCall](../models/chattoolcall.mdx)[] | ➖ | Tool calls made by the assistant | | \ No newline at end of file diff --git a/docs/models/chataudiooutput.mdx b/docs/models/chataudiooutput.mdx index 503dc8a8b..c7b6a839d 100644 --- a/docs/models/chataudiooutput.mdx +++ b/docs/models/chataudiooutput.mdx @@ -16,7 +16,7 @@ let value: ChatAudioOutput = {}; | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `data` | *string* | :heavy_minus_sign: | Base64 encoded audio data | -| `expiresAt` | *number* | :heavy_minus_sign: | Audio expiration timestamp | -| `id` | *string* | :heavy_minus_sign: | Audio output identifier | -| `transcript` | *string* | :heavy_minus_sign: | Audio transcript | \ No newline at end of file +| `data` | *string* | ➖ | Base64 encoded audio data | +| `expiresAt` | *number* | ➖ | Audio expiration timestamp | +| `id` | *string* | ➖ | Audio output identifier | +| `transcript` | *string* | ➖ | Audio transcript | \ No newline at end of file diff --git a/docs/models/chatchoice.mdx b/docs/models/chatchoice.mdx index c8ced91ab..281b38fe7 100644 --- a/docs/models/chatchoice.mdx +++ b/docs/models/chatchoice.mdx @@ -22,7 +22,7 @@ let value: ChatChoice = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `finishReason` | [models.ChatFinishReasonEnum](../models/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | -| `index` | *number* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [models.ChatTokenLogprobs](../models/chattokenlogprobs.mdx) | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | -| `message` | [models.ChatAssistantMessage](../models/chatassistantmessage.mdx) | :heavy_check_mark: | Assistant message for requests and responses | \{
"content": "What is the capital of France?",
"role": "user"
} | \ No newline at end of file +| `finishReason` | [models.ChatFinishReasonEnum](../models/chatfinishreasonenum.mdx) | ✅ | N/A | stop | +| `index` | *number* | ✅ | Choice index | 0 | +| `logprobs` | [models.ChatTokenLogprobs](../models/chattokenlogprobs.mdx) | ➖ | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | +| `message` | [models.ChatAssistantMessage](../models/chatassistantmessage.mdx) | ✅ | Assistant message for requests and responses | \{
"content": "What is the capital of France?",
"role": "user"
} | \ No newline at end of file diff --git a/docs/models/chatcontentaudio.mdx b/docs/models/chatcontentaudio.mdx index 44a3473a7..ca4095897 100644 --- a/docs/models/chatcontentaudio.mdx +++ b/docs/models/chatcontentaudio.mdx @@ -22,5 +22,5 @@ let value: ChatContentAudio = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `inputAudio` | [models.ChatContentAudioInputAudio](../models/chatcontentaudioinputaudio.mdx) | :heavy_check_mark: | N/A | -| `type` | *"input_audio"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `inputAudio` | [models.ChatContentAudioInputAudio](../models/chatcontentaudioinputaudio.mdx) | ✅ | N/A | +| `type` | *"input_audio"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chatcontentaudioinputaudio.mdx b/docs/models/chatcontentaudioinputaudio.mdx index d8ae7208b..74b1813db 100644 --- a/docs/models/chatcontentaudioinputaudio.mdx +++ b/docs/models/chatcontentaudioinputaudio.mdx @@ -17,5 +17,5 @@ let value: ChatContentAudioInputAudio = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `data` | *string* | :heavy_check_mark: | Base64 encoded audio data | -| `format` | *string* | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | \ No newline at end of file +| `data` | *string* | ✅ | Base64 encoded audio data | +| `format` | *string* | ✅ | Audio format (e.g., wav, mp3, flac, m4a, ogg, aiff, aac, pcm16, pcm24). Supported formats vary by provider. | \ No newline at end of file diff --git a/docs/models/chatcontentcachecontrol.mdx b/docs/models/chatcontentcachecontrol.mdx index a365a735d..300bb8ba7 100644 --- a/docs/models/chatcontentcachecontrol.mdx +++ b/docs/models/chatcontentcachecontrol.mdx @@ -18,5 +18,5 @@ let value: ChatContentCacheControl = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ttl` | [models.AnthropicCacheControlTtl](../models/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `type` | [models.ChatContentCacheControlType](../models/chatcontentcachecontroltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ttl` | [models.AnthropicCacheControlTtl](../models/anthropiccachecontrolttl.mdx) | ➖ | N/A | 5m | +| `type` | [models.ChatContentCacheControlType](../models/chatcontentcachecontroltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/chatcontentfile.mdx b/docs/models/chatcontentfile.mdx index d00083f95..9d4e93744 100644 --- a/docs/models/chatcontentfile.mdx +++ b/docs/models/chatcontentfile.mdx @@ -19,5 +19,5 @@ let value: ChatContentFile = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `file` | [models.ChatContentFileFile](../models/chatcontentfilefile.mdx) | :heavy_check_mark: | N/A | -| `type` | *"file"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `file` | [models.ChatContentFileFile](../models/chatcontentfilefile.mdx) | ✅ | N/A | +| `type` | *"file"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chatcontentfilefile.mdx b/docs/models/chatcontentfilefile.mdx index 4b7b7624b..b6ceecee9 100644 --- a/docs/models/chatcontentfilefile.mdx +++ b/docs/models/chatcontentfilefile.mdx @@ -14,6 +14,6 @@ let value: ChatContentFileFile = {}; | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `fileData` | *string* | :heavy_minus_sign: | File content as base64 data URL or URL | -| `fileId` | *string* | :heavy_minus_sign: | File ID for previously uploaded files | -| `filename` | *string* | :heavy_minus_sign: | Original filename | \ No newline at end of file +| `fileData` | *string* | ➖ | File content as base64 data URL or URL | +| `fileId` | *string* | ➖ | File ID for previously uploaded files | +| `filename` | *string* | ➖ | Original filename | \ No newline at end of file diff --git a/docs/models/chatcontentimage.mdx b/docs/models/chatcontentimage.mdx index d774cf20a..79085f1a4 100644 --- a/docs/models/chatcontentimage.mdx +++ b/docs/models/chatcontentimage.mdx @@ -21,5 +21,5 @@ let value: ChatContentImage = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `imageUrl` | [models.ChatContentImageImageUrl](../models/chatcontentimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | *"image_url"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [models.ChatContentImageImageUrl](../models/chatcontentimageimageurl.mdx) | ✅ | N/A | +| `type` | *"image_url"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chatcontentimageimageurl.mdx b/docs/models/chatcontentimageimageurl.mdx index c958da3a1..e003f27d4 100644 --- a/docs/models/chatcontentimageimageurl.mdx +++ b/docs/models/chatcontentimageimageurl.mdx @@ -16,5 +16,5 @@ let value: ChatContentImageImageUrl = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `detail` | [models.ChatContentImageDetail](../models/chatcontentimagedetail.mdx) | :heavy_minus_sign: | Image detail level for vision models. `original` is an OpenRouter extension (not in the OpenAI Chat Completions spec) requesting true original-resolution media; it is downgraded to `high` for providers that lack an original-resolution tier. | -| `url` | *string* | :heavy_check_mark: | URL of the image (data: URLs supported) | \ No newline at end of file +| `detail` | [models.ChatContentImageDetail](../models/chatcontentimagedetail.mdx) | ➖ | Image detail level for vision models. `original` is an OpenRouter extension (not in the OpenAI Chat Completions spec) requesting true original-resolution media; it is downgraded to `high` for providers that lack an original-resolution tier. | +| `url` | *string* | ✅ | URL of the image (data: URLs supported) | \ No newline at end of file diff --git a/docs/models/chatcontenttext.mdx b/docs/models/chatcontenttext.mdx index df6deebcd..721c50ee1 100644 --- a/docs/models/chatcontenttext.mdx +++ b/docs/models/chatcontenttext.mdx @@ -19,7 +19,7 @@ let value: ChatContentText = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.ChatContentCacheControl](../models/chatcontentcachecontrol.mdx) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | -| `promptCacheBreakpoint` | [models.PromptCacheBreakpoint](../models/promptcachebreakpoint.mdx) | :heavy_minus_sign: | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | -| `text` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.ChatContentTextType](../models/chatcontenttexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.ChatContentCacheControl](../models/chatcontentcachecontrol.mdx) | ➖ | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | +| `promptCacheBreakpoint` | [models.PromptCacheBreakpoint](../models/promptcachebreakpoint.mdx) | ➖ | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | +| `text` | *string* | ✅ | N/A | | +| `type` | [models.ChatContentTextType](../models/chatcontenttexttype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/chatcontentvideo.mdx b/docs/models/chatcontentvideo.mdx index d15db7808..67b9e0c70 100644 --- a/docs/models/chatcontentvideo.mdx +++ b/docs/models/chatcontentvideo.mdx @@ -21,5 +21,5 @@ let value: ChatContentVideo = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `type` | *"video_url"* | :heavy_check_mark: | N/A | | -| `videoUrl` | [models.ChatContentVideoInput](../models/chatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `type` | *"video_url"* | ✅ | N/A | | +| `videoUrl` | [models.ChatContentVideoInput](../models/chatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/chatcontentvideoinput.mdx b/docs/models/chatcontentvideoinput.mdx index cbe31f07e..654fbf1f8 100644 --- a/docs/models/chatcontentvideoinput.mdx +++ b/docs/models/chatcontentvideoinput.mdx @@ -18,5 +18,5 @@ let value: ChatContentVideoInput = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `processing` | [models.ChatContentVideoInputProcessing](../models/chatcontentvideoinputprocessing.mdx) | :heavy_minus_sign: | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | -| `url` | *string* | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file +| `processing` | [models.ChatContentVideoInputProcessing](../models/chatcontentvideoinputprocessing.mdx) | ➖ | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | +| `url` | *string* | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/models/chatdebugoptions.mdx b/docs/models/chatdebugoptions.mdx index 60c02d6b9..1db4b70b3 100644 --- a/docs/models/chatdebugoptions.mdx +++ b/docs/models/chatdebugoptions.mdx @@ -16,4 +16,4 @@ let value: ChatDebugOptions = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `echoUpstreamBody` | *boolean* | :heavy_minus_sign: | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true | \ No newline at end of file +| `echoUpstreamBody` | *boolean* | ➖ | If true, includes the transformed upstream request body in a debug chunk at the start of the stream. Only works with streaming mode. | true | \ No newline at end of file diff --git a/docs/models/chatdevelopermessage.mdx b/docs/models/chatdevelopermessage.mdx index ee9a94fed..caaad4062 100644 --- a/docs/models/chatdevelopermessage.mdx +++ b/docs/models/chatdevelopermessage.mdx @@ -19,7 +19,7 @@ let value: ChatDeveloperMessage = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configurationUpdate` | [models.ChatDeveloperMessageConfigurationUpdate](../models/chatdevelopermessageconfigurationupdate.mdx) | :heavy_minus_sign: | OpenRouter extension. Same as the system message `configuration_update`: changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. | \{
"reasoning": \{
"effort": "low"
}
} | -| `content` | *models.ChatDeveloperMessageContent* | :heavy_check_mark: | Developer message content | This is a message from the developer. | -| `name` | *string* | :heavy_minus_sign: | Optional name for the developer message | Developer | -| `role` | *"developer"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `configurationUpdate` | [models.ChatDeveloperMessageConfigurationUpdate](../models/chatdevelopermessageconfigurationupdate.mdx) | ➖ | OpenRouter extension. Same as the system message `configuration_update`: changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. | \{
"reasoning": \{
"effort": "low"
}
} | +| `content` | *models.ChatDeveloperMessageContent* | ✅ | Developer message content | This is a message from the developer. | +| `name` | *string* | ➖ | Optional name for the developer message | Developer | +| `role` | *"developer"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/chatdevelopermessageconfigurationupdate.mdx b/docs/models/chatdevelopermessageconfigurationupdate.mdx index a720ab96b..298c3c178 100644 --- a/docs/models/chatdevelopermessageconfigurationupdate.mdx +++ b/docs/models/chatdevelopermessageconfigurationupdate.mdx @@ -20,4 +20,4 @@ let value: ChatDeveloperMessageConfigurationUpdate = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `reasoning` | [models.ConfigurationUpdateReasoning](../models/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file +| `reasoning` | [models.ConfigurationUpdateReasoning](../models/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file diff --git a/docs/models/chatdynamicservertool.mdx b/docs/models/chatdynamicservertool.mdx index f1d03f162..26db2c7fd 100644 --- a/docs/models/chatdynamicservertool.mdx +++ b/docs/models/chatdynamicservertool.mdx @@ -18,5 +18,5 @@ let value: ChatDynamicServerTool = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `parameters` | Record\ | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `parameters` | Record\ | ➖ | N/A | +| `type` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chatformatgrammarconfig.mdx b/docs/models/chatformatgrammarconfig.mdx index c41724b47..c50b731d4 100644 --- a/docs/models/chatformatgrammarconfig.mdx +++ b/docs/models/chatformatgrammarconfig.mdx @@ -19,5 +19,5 @@ let value: ChatFormatGrammarConfig = { | Field | Type | Required | Description | Example | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `grammar` | *string* | :heavy_check_mark: | Custom grammar for text generation | root ::= "yes" \| "no" | -| `type` | *"grammar"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `grammar` | *string* | ✅ | Custom grammar for text generation | root ::= "yes" \| "no" | +| `type` | *"grammar"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/chatformatjsonobjectconfig.mdx b/docs/models/chatformatjsonobjectconfig.mdx index c04c2a911..e522466d5 100644 --- a/docs/models/chatformatjsonobjectconfig.mdx +++ b/docs/models/chatformatjsonobjectconfig.mdx @@ -18,4 +18,4 @@ let value: ChatFormatJsonObjectConfig = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"json_object"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"json_object"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chatformatjsonschemaconfig.mdx b/docs/models/chatformatjsonschemaconfig.mdx index c803fdecf..32d9fa88f 100644 --- a/docs/models/chatformatjsonschemaconfig.mdx +++ b/docs/models/chatformatjsonschemaconfig.mdx @@ -21,5 +21,5 @@ let value: ChatFormatJsonSchemaConfig = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `jsonSchema` | [models.ChatJsonSchemaConfig](../models/chatjsonschemaconfig.mdx) | :heavy_check_mark: | JSON Schema configuration object | \{
"description": "A mathematical response",
"name": "math_response",
"schema": \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
},
"strict": true
} | -| `type` | *"json_schema"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `jsonSchema` | [models.ChatJsonSchemaConfig](../models/chatjsonschemaconfig.mdx) | ✅ | JSON Schema configuration object | \{
"description": "A mathematical response",
"name": "math_response",
"schema": \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
},
"strict": true
} | +| `type` | *"json_schema"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/chatformatpythonconfig.mdx b/docs/models/chatformatpythonconfig.mdx index 40a04ee17..7121e7436 100644 --- a/docs/models/chatformatpythonconfig.mdx +++ b/docs/models/chatformatpythonconfig.mdx @@ -18,4 +18,4 @@ let value: ChatFormatPythonConfig = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"python"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"python"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chatformattextconfig.mdx b/docs/models/chatformattextconfig.mdx index 97b4c27d0..bf4c794c4 100644 --- a/docs/models/chatformattextconfig.mdx +++ b/docs/models/chatformattextconfig.mdx @@ -18,4 +18,4 @@ let value: ChatFormatTextConfig = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"text"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chatfunctiontoolfunction.mdx b/docs/models/chatfunctiontoolfunction.mdx index d7d0bc5a8..3dbf817e9 100644 --- a/docs/models/chatfunctiontoolfunction.mdx +++ b/docs/models/chatfunctiontoolfunction.mdx @@ -19,6 +19,6 @@ let value: ChatFunctionToolFunction = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.ChatContentCacheControl](../models/chatcontentcachecontrol.mdx) | :heavy_minus_sign: | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | -| `function` | [models.ChatFunctionToolFunctionFunction](../models/chatfunctiontoolfunctionfunction.mdx) | :heavy_check_mark: | Function definition for tool calling | \{
"description": "Get the current weather for a location",
"name": "get_weather",
"parameters": \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
}
} | -| `type` | [models.ChatFunctionToolType](../models/chatfunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.ChatContentCacheControl](../models/chatcontentcachecontrol.mdx) | ➖ | Anthropic-style cache breakpoint for the content part. Interchangeable with the OpenAI-style `prompt_cache_breakpoint` marker: OpenRouter converts between the two based on the provider serving the request. | \{
"ttl": "5m",
"type": "ephemeral"
} | +| `function` | [models.ChatFunctionToolFunctionFunction](../models/chatfunctiontoolfunctionfunction.mdx) | ✅ | Function definition for tool calling | \{
"description": "Get the current weather for a location",
"name": "get_weather",
"parameters": \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
}
} | +| `type` | [models.ChatFunctionToolType](../models/chatfunctiontooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/chatfunctiontoolfunctionfunction.mdx b/docs/models/chatfunctiontoolfunctionfunction.mdx index aca7546e9..47d79b533 100644 --- a/docs/models/chatfunctiontoolfunctionfunction.mdx +++ b/docs/models/chatfunctiontoolfunctionfunction.mdx @@ -18,7 +18,7 @@ let value: ChatFunctionToolFunctionFunction = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *string* | :heavy_minus_sign: | Function description for the model | Get the current weather for a location | -| `name` | *string* | :heavy_check_mark: | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | -| `parameters` | Record\ | :heavy_minus_sign: | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | -| `strict` | *boolean* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file +| `description` | *string* | ➖ | Function description for the model | Get the current weather for a location | +| `name` | *string* | ✅ | Function name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | get_weather | +| `parameters` | Record\ | ➖ | Function parameters as JSON Schema object | \{
"properties": \{
"location": \{
"description": "City name",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
} | +| `strict` | *boolean* | ➖ | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/models/chatjsonschemaconfig.mdx b/docs/models/chatjsonschemaconfig.mdx index c19539ac7..5a43e708c 100644 --- a/docs/models/chatjsonschemaconfig.mdx +++ b/docs/models/chatjsonschemaconfig.mdx @@ -18,7 +18,7 @@ let value: ChatJsonSchemaConfig = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `description` | *string* | :heavy_minus_sign: | Schema description for the model | A mathematical response | -| `name` | *string* | :heavy_check_mark: | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | -| `schema` | Record\ | :heavy_minus_sign: | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | -| `strict` | *boolean* | :heavy_minus_sign: | Enable strict schema adherence | false | \ No newline at end of file +| `description` | *string* | ➖ | Schema description for the model | A mathematical response | +| `name` | *string* | ✅ | Schema name (a-z, A-Z, 0-9, underscores, dashes, max 64 chars) | math_response | +| `schema` | Record\ | ➖ | JSON Schema object | \{
"properties": \{
"answer": \{
"type": "number"
}
},
"required": [
"answer"
],
"type": "object"
} | +| `strict` | *boolean* | ➖ | Enable strict schema adherence | false | \ No newline at end of file diff --git a/docs/models/chatnamedtoolchoice.mdx b/docs/models/chatnamedtoolchoice.mdx index b314de24f..f6f56e55a 100644 --- a/docs/models/chatnamedtoolchoice.mdx +++ b/docs/models/chatnamedtoolchoice.mdx @@ -21,5 +21,5 @@ let value: ChatNamedToolChoice = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `function` | [models.ChatNamedToolChoiceFunction](../models/chatnamedtoolchoicefunction.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.ChatNamedToolChoiceType](../models/chatnamedtoolchoicetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `function` | [models.ChatNamedToolChoiceFunction](../models/chatnamedtoolchoicefunction.mdx) | ✅ | N/A | +| `type` | [models.ChatNamedToolChoiceType](../models/chatnamedtoolchoicetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chatnamedtoolchoicefunction.mdx b/docs/models/chatnamedtoolchoicefunction.mdx index a4d253a9c..01a9d4509 100644 --- a/docs/models/chatnamedtoolchoicefunction.mdx +++ b/docs/models/chatnamedtoolchoicefunction.mdx @@ -16,4 +16,4 @@ let value: ChatNamedToolChoiceFunction = { | Field | Type | Required | Description | Example | | --------------------- | --------------------- | --------------------- | --------------------- | --------------------- | -| `name` | *string* | :heavy_check_mark: | Function name to call | get_weather | \ No newline at end of file +| `name` | *string* | ✅ | Function name to call | get_weather | \ No newline at end of file diff --git a/docs/models/chatrequest.mdx b/docs/models/chatrequest.mdx index 6437bdc33..4dc3667e5 100644 --- a/docs/models/chatrequest.mdx +++ b/docs/models/chatrequest.mdx @@ -27,44 +27,44 @@ let value: ChatRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `debug` | [models.ChatDebugOptions](../models/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `imageConfig` | Record\ | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | -| `logitBias` | Record\ | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | -| `logprobs` | *boolean* | :heavy_minus_sign: | Return log probabilities | false | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | Maximum tokens in completion | 100 | -| `maxTokens` | *number* | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `messages` | *models.ChatMessages*[] | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | -| `metadata` | Record\ | :heavy_minus_sign: | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | -| `minP` | *number* | :heavy_minus_sign: | Minimum probability threshold relative to the most likely token. Tokens with probability below min_p * (probability of top token) are filtered out. Not all providers support this parameter. | 0.1 | -| `modalities` | [models.Modality](../models/modality.mdx)[] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | -| `model` | *string* | :heavy_minus_sign: | Model to use for completion | openai/gpt-4 | -| `models` | *string*[] | :heavy_minus_sign: | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | Whether to enable parallel function calling during tool use. When true, the model may generate multiple tool calls in a single response. | true | -| `plugins` | *models.ChatRequestPlugin*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `prediction` | [models.Prediction](../models/prediction.mdx) | :heavy_minus_sign: | Static predicted output content. Supported models can use this to reduce latency when much of the response is known in advance. | \{
"content": "Expected response",
"type": "content"
} | -| `presencePenalty` | *number* | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | -| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `promptCacheOptions` | [models.PromptCacheOptions](../models/promptcacheoptions.mdx) | :heavy_minus_sign: | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | -| `provider` | [models.ProviderPreferences](../models/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [models.ChatRequestReasoning](../models/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `reasoningEffort` | [models.ChatRequestReasoningEffort](../models/chatrequestreasoningeffort.mdx) | :heavy_minus_sign: | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | -| `repetitionPenalty` | *number* | :heavy_minus_sign: | Penalizes tokens based on how much they have already appeared in the text. A value of 1.0 means no penalty. Values above 1.0 penalize repeated tokens more strongly. Not all providers support this parameter. | 1 | -| `responseFormat` | *models.ResponseFormat* | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | -| `seed` | *number* | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `serviceTier` | [models.ChatRequestServiceTier](../models/chatrequestservicetier.mdx) | :heavy_minus_sign: | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | auto | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `stop` | *models.Stop* | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | -| `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | -| `stream` | *boolean* | :heavy_minus_sign: | Enable streaming response | false | -| `streamOptions` | [models.ChatStreamOptions](../models/chatstreamoptions.mdx) | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | -| `temperature` | *number* | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `toolChoice` | *models.ChatToolChoice* | :heavy_minus_sign: | Tool choice configuration | auto | -| `tools` | *models.ChatFunctionTool*[] | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | -| `topA` | *number* | :heavy_minus_sign: | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | -| `topK` | *number* | :heavy_minus_sign: | Limits the model to choose from the top K most likely tokens at each step. A value of 1 means the model will always pick the most likely next token. Not all providers support this parameter. | 40 | -| `topLogprobs` | *number* | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | -| `topP` | *number* | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `user` | *string* | :heavy_minus_sign: | Per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `debug` | [models.ChatDebugOptions](../models/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `frequencyPenalty` | *number* | ➖ | Frequency penalty (-2.0 to 2.0) | 0 | +| `imageConfig` | Record\ | ➖ | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | +| `logitBias` | Record\ | ➖ | Token logit bias adjustments | \{
"50256": -100
} | +| `logprobs` | *boolean* | ➖ | Return log probabilities | false | +| `maxCompletionTokens` | *number* | ➖ | Maximum tokens in completion | 100 | +| `maxTokens` | *number* | ➖ | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | +| `messages` | *models.ChatMessages*[] | ✅ | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `metadata` | Record\ | ➖ | Key-value pairs for additional object information (max 16 pairs, 64 char keys, 512 char values) | \{
"session_id": "session-456",
"user_id": "user-123"
} | +| `minP` | *number* | ➖ | Minimum probability threshold relative to the most likely token. Tokens with probability below min_p * (probability of top token) are filtered out. Not all providers support this parameter. | 0.1 | +| `modalities` | [models.Modality](../models/modality.mdx)[] | ➖ | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `model` | *string* | ➖ | Model to use for completion | openai/gpt-4 | +| `models` | *string*[] | ➖ | Models to use for completion | [
"openai/gpt-4",
"openai/gpt-4o"
] | +| `parallelToolCalls` | *boolean* | ➖ | Whether to enable parallel function calling during tool use. When true, the model may generate multiple tool calls in a single response. | true | +| `plugins` | *models.ChatRequestPlugin*[] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `prediction` | [models.Prediction](../models/prediction.mdx) | ➖ | Static predicted output content. Supported models can use this to reduce latency when much of the response is known in advance. | \{
"content": "Expected response",
"type": "content"
} | +| `presencePenalty` | *number* | ➖ | Presence penalty (-2.0 to 2.0) | 0 | +| `promptCacheKey` | *string* | ➖ | N/A | | +| `promptCacheOptions` | [models.PromptCacheOptions](../models/promptcacheoptions.mdx) | ➖ | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | +| `provider` | [models.ProviderPreferences](../models/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [models.ChatRequestReasoning](../models/chatrequestreasoning.mdx) | ➖ | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `reasoningEffort` | [models.ChatRequestReasoningEffort](../models/chatrequestreasoningeffort.mdx) | ➖ | Shorthand for setting reasoning effort. Equivalent to setting reasoning.effort. Cannot be used simultaneously with reasoning.effort if they differ. | medium | +| `repetitionPenalty` | *number* | ➖ | Penalizes tokens based on how much they have already appeared in the text. A value of 1.0 means no penalty. Values above 1.0 penalize repeated tokens more strongly. Not all providers support this parameter. | 1 | +| `responseFormat` | *models.ResponseFormat* | ➖ | Response format configuration | \{
"type": "json_object"
} | +| `seed` | *number* | ➖ | Random seed for deterministic outputs | 42 | +| `serviceTier` | [models.ChatRequestServiceTier](../models/chatrequestservicetier.mdx) | ➖ | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | auto | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | +| `stop` | *models.Stop* | ➖ | Stop sequences (up to 4) | [
"\n"
] | +| `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | +| `stream` | *boolean* | ➖ | Enable streaming response | false | +| `streamOptions` | [models.ChatStreamOptions](../models/chatstreamoptions.mdx) | ➖ | Streaming configuration options | \{
"include_usage": true
} | +| `temperature` | *number* | ➖ | Sampling temperature (0-2) | 0.7 | +| `toolChoice` | *models.ChatToolChoice* | ➖ | Tool choice configuration | auto | +| `tools` | *models.ChatFunctionTool*[] | ➖ | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `topA` | *number* | ➖ | Consider only tokens with "sufficiently high" probabilities based on the probability of the most likely token. Not all providers support this parameter. | 0 | +| `topK` | *number* | ➖ | Limits the model to choose from the top K most likely tokens at each step. A value of 1 means the model will always pick the most likely next token. Not all providers support this parameter. | 40 | +| `topLogprobs` | *number* | ➖ | Number of top log probabilities to return (0-20) | 5 | +| `topP` | *number* | ➖ | Nucleus sampling parameter (0-1) | 1 | +| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `user` | *string* | ➖ | Per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | \ No newline at end of file diff --git a/docs/models/chatrequestreasoning.mdx b/docs/models/chatrequestreasoning.mdx index 42ca90f24..5caaf398e 100644 --- a/docs/models/chatrequestreasoning.mdx +++ b/docs/models/chatrequestreasoning.mdx @@ -16,5 +16,5 @@ let value: ChatRequestReasoning = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `effort` | [models.ChatRequestEffort](../models/chatrequesteffort.mdx) | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | -| `summary` | [models.ChatReasoningSummaryVerbosityEnum](../models/chatreasoningsummaryverbosityenum.mdx) | :heavy_minus_sign: | N/A | concise | \ No newline at end of file +| `effort` | [models.ChatRequestEffort](../models/chatrequesteffort.mdx) | ➖ | Constrains effort on reasoning for reasoning models | medium | +| `summary` | [models.ChatReasoningSummaryVerbosityEnum](../models/chatreasoningsummaryverbosityenum.mdx) | ➖ | N/A | concise | \ No newline at end of file diff --git a/docs/models/chatresult.mdx b/docs/models/chatresult.mdx index 038f14313..a6a779bb4 100644 --- a/docs/models/chatresult.mdx +++ b/docs/models/chatresult.mdx @@ -31,12 +31,12 @@ let value: ChatResult = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | [models.ChatChoice](../models/chatchoice.mdx)[] | :heavy_check_mark: | List of completion choices | | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `id` | *string* | :heavy_check_mark: | Unique completion identifier | chatcmpl-123 | -| `model` | *string* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [models.ChatResultObject](../models/chatresultobject.mdx) | :heavy_check_mark: | N/A | | -| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | -| `serviceTier` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `systemFingerprint` | *string* | :heavy_check_mark: | System fingerprint | fp_44709d6fcb | -| `usage` | [models.ChatUsage](../models/chatusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file +| `choices` | [models.ChatChoice](../models/chatchoice.mdx)[] | ✅ | List of completion choices | | +| `created` | *number* | ✅ | Unix timestamp of creation | 1677652288 | +| `id` | *string* | ✅ | Unique completion identifier | chatcmpl-123 | +| `model` | *string* | ✅ | Model used for completion | openai/gpt-4 | +| `object` | [models.ChatResultObject](../models/chatresultobject.mdx) | ✅ | N/A | | +| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `serviceTier` | *string* | ➖ | The service tier used by the upstream provider for this request | default | +| `systemFingerprint` | *string* | ✅ | System fingerprint | fp_44709d6fcb | +| `usage` | [models.ChatUsage](../models/chatusage.mdx) | ➖ | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file diff --git a/docs/models/chatsearchmodelsservertool.mdx b/docs/models/chatsearchmodelsservertool.mdx index 93b1f3ec3..c97fa3558 100644 --- a/docs/models/chatsearchmodelsservertool.mdx +++ b/docs/models/chatsearchmodelsservertool.mdx @@ -18,5 +18,5 @@ let value: ChatSearchModelsServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [models.ChatSearchModelsServerToolType](../models/chatsearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [models.ChatSearchModelsServerToolType](../models/chatsearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/chatservertoolchoice.mdx b/docs/models/chatservertoolchoice.mdx index 57571fd86..07c0ec956 100644 --- a/docs/models/chatservertoolchoice.mdx +++ b/docs/models/chatservertoolchoice.mdx @@ -18,4 +18,4 @@ let value: ChatServerToolChoice = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `type` | *string* | :heavy_check_mark: | OpenRouter server-tool type to force (e.g. `openrouter:web_search`, `web_search`, `web_search_preview`). | openrouter:web_search | \ No newline at end of file +| `type` | *string* | ✅ | OpenRouter server-tool type to force (e.g. `openrouter:web_search`, `web_search`, `web_search_preview`). | openrouter:web_search | \ No newline at end of file diff --git a/docs/models/chatstreamchoice.mdx b/docs/models/chatstreamchoice.mdx index 7f04eef8a..55488e1ca 100644 --- a/docs/models/chatstreamchoice.mdx +++ b/docs/models/chatstreamchoice.mdx @@ -20,7 +20,7 @@ let value: ChatStreamChoice = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `delta` | [models.ChatStreamDelta](../models/chatstreamdelta.mdx) | :heavy_check_mark: | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | -| `finishReason` | [models.ChatFinishReasonEnum](../models/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | -| `index` | *number* | :heavy_check_mark: | Choice index | 0 | -| `logprobs` | [models.ChatTokenLogprobs](../models/chattokenlogprobs.mdx) | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | \ No newline at end of file +| `delta` | [models.ChatStreamDelta](../models/chatstreamdelta.mdx) | ✅ | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | +| `finishReason` | [models.ChatFinishReasonEnum](../models/chatfinishreasonenum.mdx) | ✅ | N/A | stop | +| `index` | *number* | ✅ | Choice index | 0 | +| `logprobs` | [models.ChatTokenLogprobs](../models/chattokenlogprobs.mdx) | ➖ | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | \ No newline at end of file diff --git a/docs/models/chatstreamchunk.mdx b/docs/models/chatstreamchunk.mdx index 607b4ab3d..3de04980d 100644 --- a/docs/models/chatstreamchunk.mdx +++ b/docs/models/chatstreamchunk.mdx @@ -28,13 +28,13 @@ let value: ChatStreamChunk = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | [models.ChatStreamChoice](../models/chatstreamchoice.mdx)[] | :heavy_check_mark: | List of streaming chunk choices | | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `error` | [models.ChatStreamChunkError](../models/chatstreamchunkerror.mdx) | :heavy_minus_sign: | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | -| `id` | *string* | :heavy_check_mark: | Unique chunk identifier | chatcmpl-123 | -| `model` | *string* | :heavy_check_mark: | Model used for completion | openai/gpt-4 | -| `object` | [models.ChatStreamChunkObject](../models/chatstreamchunkobject.mdx) | :heavy_check_mark: | N/A | | -| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | -| `serviceTier` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | default | -| `systemFingerprint` | *string* | :heavy_minus_sign: | System fingerprint | fp_44709d6fcb | -| `usage` | [models.ChatUsage](../models/chatusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file +| `choices` | [models.ChatStreamChoice](../models/chatstreamchoice.mdx)[] | ✅ | List of streaming chunk choices | | +| `created` | *number* | ✅ | Unix timestamp of creation | 1677652288 | +| `error` | [models.ChatStreamChunkError](../models/chatstreamchunkerror.mdx) | ➖ | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | +| `id` | *string* | ✅ | Unique chunk identifier | chatcmpl-123 | +| `model` | *string* | ✅ | Model used for completion | openai/gpt-4 | +| `object` | [models.ChatStreamChunkObject](../models/chatstreamchunkobject.mdx) | ✅ | N/A | | +| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `serviceTier` | *string* | ➖ | The service tier used by the upstream provider for this request | default | +| `systemFingerprint` | *string* | ➖ | System fingerprint | fp_44709d6fcb | +| `usage` | [models.ChatUsage](../models/chatusage.mdx) | ➖ | Token usage statistics | \{
"completion_tokens": 15,
"completion_tokens_details": \{
"reasoning_tokens": 5
},
"cost": 0.0012,
"cost_details": \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
},
"is_byok": false,
"prompt_tokens": 10,
"prompt_tokens_details": \{
"cached_tokens": 2
},
"server_tool_use_details": \{
"tool_calls_executed": 2,
"tool_calls_requested": 2
},
"total_tokens": 25
} | \ No newline at end of file diff --git a/docs/models/chatstreamchunkerror.mdx b/docs/models/chatstreamchunkerror.mdx index 9d733e369..c7aec295e 100644 --- a/docs/models/chatstreamchunkerror.mdx +++ b/docs/models/chatstreamchunkerror.mdx @@ -19,6 +19,6 @@ let value: ChatStreamChunkError = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `code` | *number* | :heavy_check_mark: | Error code | 429 | -| `message` | *string* | :heavy_check_mark: | Error message | Rate limit exceeded | -| `metadata` | [models.ChatStreamChunkMetadata](../models/chatstreamchunkmetadata.mdx) | :heavy_minus_sign: | Structured error metadata | | \ No newline at end of file +| `code` | *number* | ✅ | Error code | 429 | +| `message` | *string* | ✅ | Error message | Rate limit exceeded | +| `metadata` | [models.ChatStreamChunkMetadata](../models/chatstreamchunkmetadata.mdx) | ➖ | Structured error metadata | | \ No newline at end of file diff --git a/docs/models/chatstreamchunkmetadata.mdx b/docs/models/chatstreamchunkmetadata.mdx index 798c97df0..747a115f7 100644 --- a/docs/models/chatstreamchunkmetadata.mdx +++ b/docs/models/chatstreamchunkmetadata.mdx @@ -18,5 +18,5 @@ let value: ChatStreamChunkMetadata = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `errorType` | [models.ApiErrorType](../models/apierrortype.mdx) | :heavy_check_mark: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `providerCode` | *string* | :heavy_minus_sign: | Upstream provider-specific error code, when available | | \ No newline at end of file +| `errorType` | [models.ApiErrorType](../models/apierrortype.mdx) | ✅ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `providerCode` | *string* | ➖ | Upstream provider-specific error code, when available | | \ No newline at end of file diff --git a/docs/models/chatstreamdelta.mdx b/docs/models/chatstreamdelta.mdx index 69b73edc2..44521d3d2 100644 --- a/docs/models/chatstreamdelta.mdx +++ b/docs/models/chatstreamdelta.mdx @@ -16,10 +16,10 @@ let value: ChatStreamDelta = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `audio` | [models.ChatAudioOutput](../models/chataudiooutput.mdx) | :heavy_minus_sign: | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | -| `content` | *string* | :heavy_minus_sign: | Message content delta | Hello | -| `reasoning` | *string* | :heavy_minus_sign: | Reasoning content delta | I need to | -| `reasoningDetails` | *models.ReasoningDetailUnion*[] | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | -| `refusal` | *string* | :heavy_minus_sign: | Refusal message delta | null | -| `role` | [models.ChatStreamDeltaRole](../models/chatstreamdeltarole.mdx) | :heavy_minus_sign: | The role of the message author | assistant | -| `toolCalls` | [models.ChatStreamToolCall](../models/chatstreamtoolcall.mdx)[] | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file +| `audio` | [models.ChatAudioOutput](../models/chataudiooutput.mdx) | ➖ | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | +| `content` | *string* | ➖ | Message content delta | Hello | +| `reasoning` | *string* | ➖ | Reasoning content delta | I need to | +| `reasoningDetails` | *models.ReasoningDetailUnion*[] | ➖ | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | +| `refusal` | *string* | ➖ | Refusal message delta | null | +| `role` | [models.ChatStreamDeltaRole](../models/chatstreamdeltarole.mdx) | ➖ | The role of the message author | assistant | +| `toolCalls` | [models.ChatStreamToolCall](../models/chatstreamtoolcall.mdx)[] | ➖ | Tool calls delta | | \ No newline at end of file diff --git a/docs/models/chatstreamingresponse.mdx b/docs/models/chatstreamingresponse.mdx index aba2941c0..377ca33b9 100644 --- a/docs/models/chatstreamingresponse.mdx +++ b/docs/models/chatstreamingresponse.mdx @@ -28,4 +28,4 @@ let value: ChatStreamingResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.ChatStreamChunk](../models/chatstreamchunk.mdx) | :heavy_check_mark: | Streaming chat completion chunk | \{
"choices": [
\{
"delta": \{
"content": "Hello",
"role": "assistant"
},
"finish_reason": null,
"index": 0
}
],
"created": 1677652288,
"id": "chatcmpl-123",
"model": "openai/gpt-4",
"object": "chat.completion.chunk"
} | \ No newline at end of file +| `data` | [models.ChatStreamChunk](../models/chatstreamchunk.mdx) | ✅ | Streaming chat completion chunk | \{
"choices": [
\{
"delta": \{
"content": "Hello",
"role": "assistant"
},
"finish_reason": null,
"index": 0
}
],
"created": 1677652288,
"id": "chatcmpl-123",
"model": "openai/gpt-4",
"object": "chat.completion.chunk"
} | \ No newline at end of file diff --git a/docs/models/chatstreamoptions.mdx b/docs/models/chatstreamoptions.mdx index 28ec27ed5..cd79f7e4a 100644 --- a/docs/models/chatstreamoptions.mdx +++ b/docs/models/chatstreamoptions.mdx @@ -16,4 +16,4 @@ let value: ChatStreamOptions = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ~~`includeUsage`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: This field has no effect. Full usage details are always included. | true | \ No newline at end of file +| ~~`includeUsage`~~ | *boolean* | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: This field has no effect. Full usage details are always included. | true | \ No newline at end of file diff --git a/docs/models/chatstreamtoolcall.mdx b/docs/models/chatstreamtoolcall.mdx index 2f47f0657..86a5008f9 100644 --- a/docs/models/chatstreamtoolcall.mdx +++ b/docs/models/chatstreamtoolcall.mdx @@ -18,7 +18,7 @@ let value: ChatStreamToolCall = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `function` | [models.ChatStreamToolCallFunction](../models/chatstreamtoolcallfunction.mdx) | :heavy_minus_sign: | Function call details | | -| `id` | *string* | :heavy_minus_sign: | Tool call identifier | call_abc123 | -| `index` | *number* | :heavy_check_mark: | Tool call index in the array | 0 | -| `type` | [models.ChatStreamToolCallType](../models/chatstreamtoolcalltype.mdx) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file +| `function` | [models.ChatStreamToolCallFunction](../models/chatstreamtoolcallfunction.mdx) | ➖ | Function call details | | +| `id` | *string* | ➖ | Tool call identifier | call_abc123 | +| `index` | *number* | ✅ | Tool call index in the array | 0 | +| `type` | [models.ChatStreamToolCallType](../models/chatstreamtoolcalltype.mdx) | ➖ | Tool call type | function | \ No newline at end of file diff --git a/docs/models/chatstreamtoolcallfunction.mdx b/docs/models/chatstreamtoolcallfunction.mdx index 6d651e81d..451a50137 100644 --- a/docs/models/chatstreamtoolcallfunction.mdx +++ b/docs/models/chatstreamtoolcallfunction.mdx @@ -16,5 +16,5 @@ let value: ChatStreamToolCallFunction = {}; | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *string* | :heavy_minus_sign: | Function arguments as JSON string | \{"location": "..."} | -| `name` | *string* | :heavy_minus_sign: | Function name | get_weather | \ No newline at end of file +| `arguments` | *string* | ➖ | Function arguments as JSON string | \{"location": "..."} | +| `name` | *string* | ➖ | Function name | get_weather | \ No newline at end of file diff --git a/docs/models/chatsystemmessage.mdx b/docs/models/chatsystemmessage.mdx index 50c1cf020..2ca5e9bbf 100644 --- a/docs/models/chatsystemmessage.mdx +++ b/docs/models/chatsystemmessage.mdx @@ -19,7 +19,7 @@ let value: ChatSystemMessage = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `configurationUpdate` | [models.ChatSystemMessageConfigurationUpdate](../models/chatsystemmessageconfigurationupdate.mdx) | :heavy_minus_sign: | OpenRouter extension. Changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. Place it on a content-less system message (`content: ""`) directly before the user message it should apply to, and keep it at that position in later requests. Equivalent to the OpenAI Responses `configuration_update` input item and the Anthropic Messages per-message `output_config.effort`. | \{
"reasoning": \{
"effort": "low"
}
} | -| `content` | *models.ChatSystemMessageContent* | :heavy_check_mark: | System message content | You are a helpful assistant. | -| `name` | *string* | :heavy_minus_sign: | Optional name for the system message | Assistant Config | -| `role` | *"system"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `configurationUpdate` | [models.ChatSystemMessageConfigurationUpdate](../models/chatsystemmessageconfigurationupdate.mdx) | ➖ | OpenRouter extension. Changes reasoning effort from this point in the conversation onward without invalidating the prompt cache for the preceding turns. Place it on a content-less system message (`content: ""`) directly before the user message it should apply to, and keep it at that position in later requests. Equivalent to the OpenAI Responses `configuration_update` input item and the Anthropic Messages per-message `output_config.effort`. | \{
"reasoning": \{
"effort": "low"
}
} | +| `content` | *models.ChatSystemMessageContent* | ✅ | System message content | You are a helpful assistant. | +| `name` | *string* | ➖ | Optional name for the system message | Assistant Config | +| `role` | *"system"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/chatsystemmessageconfigurationupdate.mdx b/docs/models/chatsystemmessageconfigurationupdate.mdx index 9d39a1baa..be9c420f6 100644 --- a/docs/models/chatsystemmessageconfigurationupdate.mdx +++ b/docs/models/chatsystemmessageconfigurationupdate.mdx @@ -20,4 +20,4 @@ let value: ChatSystemMessageConfigurationUpdate = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `reasoning` | [models.ConfigurationUpdateReasoning](../models/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file +| `reasoning` | [models.ConfigurationUpdateReasoning](../models/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | \ No newline at end of file diff --git a/docs/models/chattokenlogprob.mdx b/docs/models/chattokenlogprob.mdx index 9f99e4c46..f745c8763 100644 --- a/docs/models/chattokenlogprob.mdx +++ b/docs/models/chattokenlogprob.mdx @@ -27,7 +27,7 @@ let value: ChatTokenLogprob = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | UTF-8 bytes of the token | -| `logprob` | *number* | :heavy_check_mark: | Log probability of the token | -| `token` | *string* | :heavy_check_mark: | The token | -| `topLogprobs` | [models.ChatTokenLogprobTopLogprob](../models/chattokenlogprobtoplogprob.mdx)[] | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file +| `bytes` | *number*[] | ✅ | UTF-8 bytes of the token | +| `logprob` | *number* | ✅ | Log probability of the token | +| `token` | *string* | ✅ | The token | +| `topLogprobs` | [models.ChatTokenLogprobTopLogprob](../models/chattokenlogprobtoplogprob.mdx)[] | ✅ | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/docs/models/chattokenlogprobs.mdx b/docs/models/chattokenlogprobs.mdx index 11bbf83db..86592b458 100644 --- a/docs/models/chattokenlogprobs.mdx +++ b/docs/models/chattokenlogprobs.mdx @@ -25,5 +25,5 @@ let value: ChatTokenLogprobs = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `content` | [models.ChatTokenLogprob](../models/chattokenlogprob.mdx)[] | :heavy_check_mark: | Log probabilities for content tokens | -| `refusal` | [models.ChatTokenLogprob](../models/chattokenlogprob.mdx)[] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file +| `content` | [models.ChatTokenLogprob](../models/chattokenlogprob.mdx)[] | ✅ | Log probabilities for content tokens | +| `refusal` | [models.ChatTokenLogprob](../models/chattokenlogprob.mdx)[] | ➖ | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/docs/models/chattokenlogprobtoplogprob.mdx b/docs/models/chattokenlogprobtoplogprob.mdx index c8d6c85d4..2f566c98f 100644 --- a/docs/models/chattokenlogprobtoplogprob.mdx +++ b/docs/models/chattokenlogprobtoplogprob.mdx @@ -21,6 +21,6 @@ let value: ChatTokenLogprobTopLogprob = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes` | *number*[] | ✅ | N/A | +| `logprob` | *number* | ✅ | N/A | +| `token` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chattoolcall.mdx b/docs/models/chattoolcall.mdx index 174621eab..bceb22cab 100644 --- a/docs/models/chattoolcall.mdx +++ b/docs/models/chattoolcall.mdx @@ -23,6 +23,6 @@ let value: ChatToolCall = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `function` | [models.ChatToolCallFunction](../models/chattoolcallfunction.mdx) | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | Tool call identifier | -| `type` | [models.ChatToolCallType](../models/chattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `function` | [models.ChatToolCallFunction](../models/chattoolcallfunction.mdx) | ✅ | N/A | +| `id` | *string* | ✅ | Tool call identifier | +| `type` | [models.ChatToolCallType](../models/chattoolcalltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/chattoolcallfunction.mdx b/docs/models/chattoolcallfunction.mdx index 14c53f760..1da38b0f0 100644 --- a/docs/models/chattoolcallfunction.mdx +++ b/docs/models/chattoolcallfunction.mdx @@ -17,5 +17,5 @@ let value: ChatToolCallFunction = { | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | Function arguments as JSON string | -| `name` | *string* | :heavy_check_mark: | Function name to call | \ No newline at end of file +| `arguments` | *string* | ✅ | Function arguments as JSON string | +| `name` | *string* | ✅ | Function name to call | \ No newline at end of file diff --git a/docs/models/chattoolmessage.mdx b/docs/models/chattoolmessage.mdx index a4f0e6b1a..510222357 100644 --- a/docs/models/chattoolmessage.mdx +++ b/docs/models/chattoolmessage.mdx @@ -20,6 +20,6 @@ let value: ChatToolMessage = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `content` | *models.ChatToolMessageContent* | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | -| `role` | *"tool"* | :heavy_check_mark: | N/A | | -| `toolCallId` | *string* | :heavy_check_mark: | ID of the assistant message tool call this message responds to | call_abc123 | \ No newline at end of file +| `content` | *models.ChatToolMessageContent* | ✅ | Tool response content | The weather in San Francisco is 72°F and sunny. | +| `role` | *"tool"* | ✅ | N/A | | +| `toolCallId` | *string* | ✅ | ID of the assistant message tool call this message responds to | call_abc123 | \ No newline at end of file diff --git a/docs/models/chatusage.mdx b/docs/models/chatusage.mdx index f3b6d7388..08ae5acec 100644 --- a/docs/models/chatusage.mdx +++ b/docs/models/chatusage.mdx @@ -20,12 +20,12 @@ let value: ChatUsage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `completionTokens` | *number* | :heavy_check_mark: | Number of tokens in the completion | | -| `completionTokensDetails` | [models.ChatUsageCompletionTokensDetails](../models/chatusagecompletiontokensdetails.mdx) | :heavy_minus_sign: | Detailed completion token usage | | -| `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `promptTokens` | *number* | :heavy_check_mark: | Number of tokens in the prompt | | -| `promptTokensDetails` | [models.ChatUsagePromptTokensDetails](../models/chatusageprompttokensdetails.mdx) | :heavy_minus_sign: | Detailed prompt token usage | | -| `serverToolUseDetails` | [models.ServerToolUseDetails](../models/servertoolusedetails.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | -| `totalTokens` | *number* | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file +| `completionTokens` | *number* | ✅ | Number of tokens in the completion | | +| `completionTokensDetails` | [models.ChatUsageCompletionTokensDetails](../models/chatusagecompletiontokensdetails.mdx) | ➖ | Detailed completion token usage | | +| `cost` | *number* | ➖ | Cost of the completion | | +| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `isByok` | *boolean* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `promptTokens` | *number* | ✅ | Number of tokens in the prompt | | +| `promptTokensDetails` | [models.ChatUsagePromptTokensDetails](../models/chatusageprompttokensdetails.mdx) | ➖ | Detailed prompt token usage | | +| `serverToolUseDetails` | [models.ServerToolUseDetails](../models/servertoolusedetails.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | +| `totalTokens` | *number* | ✅ | Total number of tokens | | \ No newline at end of file diff --git a/docs/models/chatusagecompletiontokensdetails.mdx b/docs/models/chatusagecompletiontokensdetails.mdx index a6e45a230..973e046f4 100644 --- a/docs/models/chatusagecompletiontokensdetails.mdx +++ b/docs/models/chatusagecompletiontokensdetails.mdx @@ -16,7 +16,7 @@ let value: ChatUsageCompletionTokensDetails = {}; | Field | Type | Required | Description | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `acceptedPredictionTokens` | *number* | :heavy_minus_sign: | Accepted prediction tokens | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens used for audio output | -| `reasoningTokens` | *number* | :heavy_minus_sign: | Tokens used for reasoning | -| `rejectedPredictionTokens` | *number* | :heavy_minus_sign: | Rejected prediction tokens | \ No newline at end of file +| `acceptedPredictionTokens` | *number* | ➖ | Accepted prediction tokens | +| `audioTokens` | *number* | ➖ | Tokens used for audio output | +| `reasoningTokens` | *number* | ➖ | Tokens used for reasoning | +| `rejectedPredictionTokens` | *number* | ➖ | Rejected prediction tokens | \ No newline at end of file diff --git a/docs/models/chatusageprompttokensdetails.mdx b/docs/models/chatusageprompttokensdetails.mdx index 7159e5280..e63b3bdfd 100644 --- a/docs/models/chatusageprompttokensdetails.mdx +++ b/docs/models/chatusageprompttokensdetails.mdx @@ -16,7 +16,7 @@ let value: ChatUsagePromptTokensDetails = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audioTokens` | *number* | :heavy_minus_sign: | Audio input tokens | -| `cacheWriteTokens` | *number* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cachedTokens` | *number* | :heavy_minus_sign: | Cached prompt tokens | -| `videoTokens` | *number* | :heavy_minus_sign: | Video input tokens | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Audio input tokens | +| `cacheWriteTokens` | *number* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cachedTokens` | *number* | ➖ | Cached prompt tokens | +| `videoTokens` | *number* | ➖ | Video input tokens | \ No newline at end of file diff --git a/docs/models/chatusermessage.mdx b/docs/models/chatusermessage.mdx index 252eb1527..b428057a4 100644 --- a/docs/models/chatusermessage.mdx +++ b/docs/models/chatusermessage.mdx @@ -19,6 +19,6 @@ let value: ChatUserMessage = { | Field | Type | Required | Description | Example | | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `content` | *models.ChatUserMessageContent* | :heavy_check_mark: | User message content | What is the capital of France? | -| `name` | *string* | :heavy_minus_sign: | Optional name for the user | User | -| `role` | *"user"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | *models.ChatUserMessageContent* | ✅ | User message content | What is the capital of France? | +| `name` | *string* | ➖ | Optional name for the user | User | +| `role` | *"user"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/chatwebsearchshorthand.mdx b/docs/models/chatwebsearchshorthand.mdx index 2024a2fdf..d950e0a55 100644 --- a/docs/models/chatwebsearchshorthand.mdx +++ b/docs/models/chatwebsearchshorthand.mdx @@ -18,16 +18,16 @@ let value: ChatWebSearchShorthand = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | -| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `excludedDomains` | *string*[] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `maxCharacters` | *number* | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `maxTotalResults` | *number* | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `parameters` | [models.WebSearchConfig](../models/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `type` | [models.ChatWebSearchShorthandType](../models/chatwebsearchshorthandtype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.WebSearchUserLocationServerTool](../models/websearchuserlocationservertool.mdx) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `allowedDomains` | *string*[] | ➖ | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `excludedDomains` | *string*[] | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `maxCharacters` | *number* | ➖ | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | +| `maxResults` | *number* | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `maxTotalResults` | *number* | ➖ | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | +| `maxUses` | *number* | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `parameters` | [models.WebSearchConfig](../models/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel.mdx) | ➖ | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `type` | [models.ChatWebSearchShorthandType](../models/chatwebsearchshorthandtype.mdx) | ✅ | N/A | | +| `userLocation` | [models.WebSearchUserLocationServerTool](../models/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/choice.mdx b/docs/models/choice.mdx index 217deba3f..537eb43a2 100644 --- a/docs/models/choice.mdx +++ b/docs/models/choice.mdx @@ -33,8 +33,8 @@ let value: Choice = { | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `finishReason` | [models.FinishReason](../models/finishreason.mdx) | :heavy_check_mark: | N/A | stop | -| `index` | *number* | :heavy_check_mark: | N/A | | -| `logprobs` | [models.Logprobs](../models/logprobs.mdx) | :heavy_check_mark: | N/A | | -| `message` | [models.Message](../models/message.mdx) | :heavy_check_mark: | N/A | | -| `nativeFinishReason` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `finishReason` | [models.FinishReason](../models/finishreason.mdx) | ✅ | N/A | stop | +| `index` | *number* | ✅ | N/A | | +| `logprobs` | [models.Logprobs](../models/logprobs.mdx) | ✅ | N/A | | +| `message` | [models.Message](../models/message.mdx) | ✅ | N/A | | +| `nativeFinishReason` | *string* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/codeinterpretercallcodedeltaevent.mdx b/docs/models/codeinterpretercallcodedeltaevent.mdx index f88e0e993..68d2591bb 100644 --- a/docs/models/codeinterpretercallcodedeltaevent.mdx +++ b/docs/models/codeinterpretercallcodedeltaevent.mdx @@ -22,8 +22,8 @@ let value: CodeInterpreterCallCodeDeltaEvent = { | Field | Type | Required | Description | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.code_interpreter_call_code.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.code_interpreter_call_code.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/codeinterpretercallcodedoneevent.mdx b/docs/models/codeinterpretercallcodedoneevent.mdx index 179f37e21..4f4d0c5f1 100644 --- a/docs/models/codeinterpretercallcodedoneevent.mdx +++ b/docs/models/codeinterpretercallcodedoneevent.mdx @@ -22,8 +22,8 @@ let value: CodeInterpreterCallCodeDoneEvent = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `code` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.code_interpreter_call_code.done"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.code_interpreter_call_code.done"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/codeinterpretercallcompletedevent.mdx b/docs/models/codeinterpretercallcompletedevent.mdx index 7894403b2..80bee62e8 100644 --- a/docs/models/codeinterpretercallcompletedevent.mdx +++ b/docs/models/codeinterpretercallcompletedevent.mdx @@ -21,7 +21,7 @@ let value: CodeInterpreterCallCompletedEvent = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.code_interpreter_call.completed"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.code_interpreter_call.completed"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/codeinterpretercallinprogressevent.mdx b/docs/models/codeinterpretercallinprogressevent.mdx index 935ae77c1..4e997d255 100644 --- a/docs/models/codeinterpretercallinprogressevent.mdx +++ b/docs/models/codeinterpretercallinprogressevent.mdx @@ -21,7 +21,7 @@ let value: CodeInterpreterCallInProgressEvent = { | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.code_interpreter_call.in_progress"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.code_interpreter_call.in_progress"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/codeinterpretercallinterpretingevent.mdx b/docs/models/codeinterpretercallinterpretingevent.mdx index dba73b79d..106a793ff 100644 --- a/docs/models/codeinterpretercallinterpretingevent.mdx +++ b/docs/models/codeinterpretercallinterpretingevent.mdx @@ -21,7 +21,7 @@ let value: CodeInterpreterCallInterpretingEvent = { | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.code_interpreter_call.interpreting"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.code_interpreter_call.interpreting"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/codeinterpreterfileoutput.mdx b/docs/models/codeinterpreterfileoutput.mdx index 3da4f2c93..d69fd5279 100644 --- a/docs/models/codeinterpreterfileoutput.mdx +++ b/docs/models/codeinterpreterfileoutput.mdx @@ -16,13 +16,13 @@ let value: CodeInterpreterFileOutput = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `downloadUrl` | *string* | :heavy_minus_sign: | Provider-issued download URL for the generated file. Typically signed and time-limited (see `expires_at`); fetch promptly rather than persisting the URL. | -| `errorCode` | *string* | :heavy_minus_sign: | Provider error code when generating or persisting the file failed; null or absent on success. | -| `expiresAt` | *string* | :heavy_minus_sign: | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | -| `filename` | *string* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `mediaType` | *string* | :heavy_minus_sign: | N/A | -| `sha256` | *string* | :heavy_minus_sign: | N/A | -| `sizeBytes` | *number* | :heavy_minus_sign: | N/A | -| `status` | *string* | :heavy_minus_sign: | Provider-reported readiness of the generated file (e.g. `ready`). Values other than `ready` indicate the artifact may not be downloadable. | -| `type` | *"file"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `downloadUrl` | *string* | ➖ | Provider-issued download URL for the generated file. Typically signed and time-limited (see `expires_at`); fetch promptly rather than persisting the URL. | +| `errorCode` | *string* | ➖ | Provider error code when generating or persisting the file failed; null or absent on success. | +| `expiresAt` | *string* | ➖ | When the `download_url` stops working, as an ISO 8601 timestamp. After this time the file must be regenerated. | +| `filename` | *string* | ➖ | N/A | +| `id` | *string* | ➖ | N/A | +| `mediaType` | *string* | ➖ | N/A | +| `sha256` | *string* | ➖ | N/A | +| `sizeBytes` | *number* | ➖ | N/A | +| `status` | *string* | ➖ | Provider-reported readiness of the generated file (e.g. `ready`). Values other than `ready` indicate the artifact may not be downloadable. | +| `type` | *"file"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/codeinterpreterimageoutput.mdx b/docs/models/codeinterpreterimageoutput.mdx index e5599d79f..bdb27def9 100644 --- a/docs/models/codeinterpreterimageoutput.mdx +++ b/docs/models/codeinterpreterimageoutput.mdx @@ -17,5 +17,5 @@ let value: CodeInterpreterImageOutput = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"image"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"image"* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/codeinterpreterlogsoutput.mdx b/docs/models/codeinterpreterlogsoutput.mdx index 7ae382d87..d808c9f87 100644 --- a/docs/models/codeinterpreterlogsoutput.mdx +++ b/docs/models/codeinterpreterlogsoutput.mdx @@ -17,5 +17,5 @@ let value: CodeInterpreterLogsOutput = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `logs` | *string* | :heavy_check_mark: | N/A | -| `type` | *"logs"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `logs` | *string* | ✅ | N/A | +| `type` | *"logs"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/codeinterpreterservertool.mdx b/docs/models/codeinterpreterservertool.mdx index e57cb0dc5..3e9d9c5f5 100644 --- a/docs/models/codeinterpreterservertool.mdx +++ b/docs/models/codeinterpreterservertool.mdx @@ -19,5 +19,5 @@ let value: CodeInterpreterServerTool = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `container` | *models.Container* | :heavy_check_mark: | N/A | -| `type` | [models.TypeCodeInterpreter](../models/typecodeinterpreter.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `container` | *models.Container* | ✅ | N/A | +| `type` | [models.TypeCodeInterpreter](../models/typecodeinterpreter.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/codexlocalshelltool.mdx b/docs/models/codexlocalshelltool.mdx index 0d502354c..d8659d590 100644 --- a/docs/models/codexlocalshelltool.mdx +++ b/docs/models/codexlocalshelltool.mdx @@ -18,4 +18,4 @@ let value: CodexLocalShellTool = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `type` | [models.CodexLocalShellToolType](../models/codexlocalshelltooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.CodexLocalShellToolType](../models/codexlocalshelltooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/compactionitem.mdx b/docs/models/compactionitem.mdx index 0f5a2c6d7..8004a39bd 100644 --- a/docs/models/compactionitem.mdx +++ b/docs/models/compactionitem.mdx @@ -19,7 +19,7 @@ let value: CompactionItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `encryptedContent` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.CompactionItemType](../models/compactionitemtype.mdx) | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file +| `encryptedContent` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `type` | [models.CompactionItemType](../models/compactionitemtype.mdx) | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file diff --git a/docs/models/compoundfilter.mdx b/docs/models/compoundfilter.mdx index dcf2b84e2..d3c12b96e 100644 --- a/docs/models/compoundfilter.mdx +++ b/docs/models/compoundfilter.mdx @@ -25,5 +25,5 @@ let value: CompoundFilter = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `filters` | Record\[] | :heavy_check_mark: | N/A | -| `type` | [models.CompoundFilterType](../models/compoundfiltertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `filters` | Record\[] | ✅ | N/A | +| `type` | [models.CompoundFilterType](../models/compoundfiltertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/computeruseservertool.mdx b/docs/models/computeruseservertool.mdx index ffe1f674f..44f4756a7 100644 --- a/docs/models/computeruseservertool.mdx +++ b/docs/models/computeruseservertool.mdx @@ -21,7 +21,7 @@ let value: ComputerUseServerTool = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `displayHeight` | *number* | :heavy_check_mark: | N/A | -| `displayWidth` | *number* | :heavy_check_mark: | N/A | -| `environment` | [models.Environment](../models/environment.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.ComputerUseServerToolType](../models/computeruseservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `displayHeight` | *number* | ✅ | N/A | +| `displayWidth` | *number* | ✅ | N/A | +| `environment` | [models.Environment](../models/environment.mdx) | ✅ | N/A | +| `type` | [models.ComputerUseServerToolType](../models/computeruseservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/configurationupdateitem.mdx b/docs/models/configurationupdateitem.mdx index e68759284..e9670639d 100644 --- a/docs/models/configurationupdateitem.mdx +++ b/docs/models/configurationupdateitem.mdx @@ -21,6 +21,6 @@ let value: ConfigurationUpdateItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `reasoning` | [models.ConfigurationUpdateReasoning](../models/configurationupdatereasoning.mdx) | :heavy_check_mark: | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | -| `type` | [models.ConfigurationUpdateItemType](../models/configurationupdateitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *string* | ➖ | N/A | | +| `reasoning` | [models.ConfigurationUpdateReasoning](../models/configurationupdatereasoning.mdx) | ✅ | Reasoning settings applied from this point in the conversation onward | \{
"effort": "low"
} | +| `type` | [models.ConfigurationUpdateItemType](../models/configurationupdateitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/configurationupdatereasoning.mdx b/docs/models/configurationupdatereasoning.mdx index 962b3b75a..c1d7a4c9a 100644 --- a/docs/models/configurationupdatereasoning.mdx +++ b/docs/models/configurationupdatereasoning.mdx @@ -18,4 +18,4 @@ let value: ConfigurationUpdateReasoning = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `effort` | [models.ConfigurationUpdateReasoningEffort](../models/configurationupdatereasoningeffort.mdx) | :heavy_check_mark: | Reasoning effort to apply from this point in the conversation onward | low | \ No newline at end of file +| `effort` | [models.ConfigurationUpdateReasoningEffort](../models/configurationupdatereasoningeffort.mdx) | ✅ | Reasoning effort to apply from this point in the conversation onward | low | \ No newline at end of file diff --git a/docs/models/conflictresponseerrordata.mdx b/docs/models/conflictresponseerrordata.mdx index fc57fc2ab..537384df8 100644 --- a/docs/models/conflictresponseerrordata.mdx +++ b/docs/models/conflictresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: ConflictResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/containerauto.mdx b/docs/models/containerauto.mdx index 6dce69021..09015787a 100644 --- a/docs/models/containerauto.mdx +++ b/docs/models/containerauto.mdx @@ -16,6 +16,6 @@ let value: ContainerAuto = { | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `fileIds` | *string*[] | :heavy_minus_sign: | N/A | -| `memoryLimit` | [models.MemoryLimit](../models/memorylimit.mdx) | :heavy_minus_sign: | N/A | -| `type` | [models.ContainerType](../models/containertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileIds` | *string*[] | ➖ | N/A | +| `memoryLimit` | [models.MemoryLimit](../models/memorylimit.mdx) | ➖ | N/A | +| `type` | [models.ContainerType](../models/containertype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/containerautoenvironment.mdx b/docs/models/containerautoenvironment.mdx index e3e2dd03b..d545ff48f 100644 --- a/docs/models/containerautoenvironment.mdx +++ b/docs/models/containerautoenvironment.mdx @@ -18,6 +18,6 @@ let value: ContainerAutoEnvironment = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `fileIds` | *string*[] | :heavy_minus_sign: | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | -| `networkPolicy` | *models.ContainerNetworkPolicy* | :heavy_minus_sign: | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | -| `type` | *"container_auto"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `fileIds` | *string*[] | ➖ | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | +| `networkPolicy` | *models.ContainerNetworkPolicy* | ➖ | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | +| `type` | *"container_auto"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/containerfile.mdx b/docs/models/containerfile.mdx index 77bd47b9a..ab0177978 100644 --- a/docs/models/containerfile.mdx +++ b/docs/models/containerfile.mdx @@ -22,10 +22,10 @@ let value: ContainerFile = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `bytes` | *number* | :heavy_check_mark: | File size in bytes. | 123 | -| `containerId` | *string* | :heavy_check_mark: | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | -| `createdAt` | *number* | :heavy_check_mark: | Unix timestamp (seconds) when the file was last synced. | 1755640000 | -| `id` | *string* | :heavy_check_mark: | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `object` | [models.ContainerFileObject](../models/containerfileobject.mdx) | :heavy_check_mark: | N/A | container.file | -| `path` | *string* | :heavy_check_mark: | Container-relative file path. | out/report.csv | -| `source` | [models.ContainerFileSource](../models/containerfilesource.mdx) | :heavy_check_mark: | Container files are always produced by the assistant sandbox. | assistant | \ No newline at end of file +| `bytes` | *number* | ✅ | File size in bytes. | 123 | +| `containerId` | *string* | ✅ | The container the file belongs to — echoes the `container_id` path parameter (OpenAI field name). | sess_abc123 | +| `createdAt` | *number* | ✅ | Unix timestamp (seconds) when the file was last synced. | 1755640000 | +| `id` | *string* | ✅ | Container file id: `cfile_` + base64url of the file path. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `object` | [models.ContainerFileObject](../models/containerfileobject.mdx) | ✅ | N/A | container.file | +| `path` | *string* | ✅ | Container-relative file path. | out/report.csv | +| `source` | [models.ContainerFileSource](../models/containerfilesource.mdx) | ✅ | Container files are always produced by the assistant sandbox. | assistant | \ No newline at end of file diff --git a/docs/models/containerfilelistresponse.mdx b/docs/models/containerfilelistresponse.mdx index f09b06de7..43796204b 100644 --- a/docs/models/containerfilelistresponse.mdx +++ b/docs/models/containerfilelistresponse.mdx @@ -20,8 +20,8 @@ let value: ContainerFileListResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.ContainerFile](../models/containerfile.mdx)[] | :heavy_check_mark: | N/A | | -| `firstId` | *string* | :heavy_check_mark: | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | -| `hasMore` | *boolean* | :heavy_check_mark: | True when another page can be fetched by passing `after=last_id`; `last_id` is non-null whenever this is true. | false | -| `lastId` | *string* | :heavy_check_mark: | Cursor for the next page (pass as `after`). The last entry’s id, except when the page stopped at the per-request scan bound on hidden bookkeeping objects: then it names the scan position and may not appear in `data`. Null only when `has_more` is false and `data` is empty. | cfile_b3V0L3JlcG9ydC5jc3Y | -| `object` | [models.ContainerFileListResponseObject](../models/containerfilelistresponseobject.mdx) | :heavy_check_mark: | N/A | list | \ No newline at end of file +| `data` | [models.ContainerFile](../models/containerfile.mdx)[] | ✅ | N/A | | +| `firstId` | *string* | ✅ | N/A | cfile_b3V0L3JlcG9ydC5jc3Y | +| `hasMore` | *boolean* | ✅ | True when another page can be fetched by passing `after=last_id`; `last_id` is non-null whenever this is true. | false | +| `lastId` | *string* | ✅ | Cursor for the next page (pass as `after`). The last entry’s id, except when the page stopped at the per-request scan bound on hidden bookkeeping objects: then it names the scan position and may not appear in `data`. Null only when `has_more` is false and `data` is empty. | cfile_b3V0L3JlcG9ydC5jc3Y | +| `object` | [models.ContainerFileListResponseObject](../models/containerfilelistresponseobject.mdx) | ✅ | N/A | list | \ No newline at end of file diff --git a/docs/models/containernetworkpolicyallowlist.mdx b/docs/models/containernetworkpolicyallowlist.mdx index 5fbfca2fe..d84155eba 100644 --- a/docs/models/containernetworkpolicyallowlist.mdx +++ b/docs/models/containernetworkpolicyallowlist.mdx @@ -20,5 +20,5 @@ let value: ContainerNetworkPolicyAllowlist = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedDomains` | *string*[] | :heavy_check_mark: | Hostnames the container may reach over ports 80/443 (max 50). Entries are lowercase hostnames or glob patterns where * matches any run of characters (e.g. *.example.com). An exact hostname does not cover its subdomains — use a glob or list each hostname. pip needs both pypi.org and files.pythonhosted.org (or *.pythonhosted.org). | [
"pypi.org",
"files.pythonhosted.org"
] | -| `type` | *"allowlist"* | :heavy_check_mark: | Outbound access restricted to the listed domains. | | \ No newline at end of file +| `allowedDomains` | *string*[] | ✅ | Hostnames the container may reach over ports 80/443 (max 50). Entries are lowercase hostnames or glob patterns where * matches any run of characters (e.g. *.example.com). An exact hostname does not cover its subdomains — use a glob or list each hostname. pip needs both pypi.org and files.pythonhosted.org (or *.pythonhosted.org). | [
"pypi.org",
"files.pythonhosted.org"
] | +| `type` | *"allowlist"* | ✅ | Outbound access restricted to the listed domains. | | \ No newline at end of file diff --git a/docs/models/containernetworkpolicydisabled.mdx b/docs/models/containernetworkpolicydisabled.mdx index f71388370..5926744f4 100644 --- a/docs/models/containernetworkpolicydisabled.mdx +++ b/docs/models/containernetworkpolicydisabled.mdx @@ -16,4 +16,4 @@ let value: ContainerNetworkPolicyDisabled = { | Field | Type | Required | Description | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `type` | *"disabled"* | :heavy_check_mark: | No outbound internet access. | \ No newline at end of file +| `type` | *"disabled"* | ✅ | No outbound internet access. | \ No newline at end of file diff --git a/docs/models/containerreferenceenvironment.mdx b/docs/models/containerreferenceenvironment.mdx index 7a8e8f446..48649942c 100644 --- a/docs/models/containerreferenceenvironment.mdx +++ b/docs/models/containerreferenceenvironment.mdx @@ -19,7 +19,7 @@ let value: ContainerReferenceEnvironment = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_check_mark: | Canonical container id to reuse (max 40 characters, letters/digits/underscores/hyphens). Any container_id previously returned by a bash or shell tool result works here and reattaches to the same container and files — including session-derived ids (sess_...) and generation-derived ids (gen_...). Note that a session-derived id is always sess_ + the sanitized session key, which is not necessarily the raw session id you sent. Using the same container_id from both the bash and shell tools shares the same files, with last-write-wins when both flush concurrently. A fresh name creates a new persistent container. Containers are always scoped to your account and workspace. | sess_abc123 | -| `fileIds` | *string*[] | :heavy_minus_sign: | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | -| `networkPolicy` | *models.ContainerNetworkPolicy* | :heavy_minus_sign: | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | -| `type` | *"container_reference"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `containerId` | *string* | ✅ | Canonical container id to reuse (max 40 characters, letters/digits/underscores/hyphens). Any container_id previously returned by a bash or shell tool result works here and reattaches to the same container and files — including session-derived ids (sess_...) and generation-derived ids (gen_...). Note that a session-derived id is always sess_ + the sanitized session key, which is not necessarily the raw session id you sent. Using the same container_id from both the bash and shell tools shares the same files, with last-write-wins when both flush concurrently. A fresh name creates a new persistent container. Containers are always scoped to your account and workspace. | sess_abc123 | +| `fileIds` | *string*[] | ➖ | Workspace file ids (or_file_…) to attach into the container before the first command runs. Each file is copied to the container home as a writable copy named \{last 8 characters of the file id}-\{base filename} (a file stored as data/report.csv with id or_file_…NR6q4V8w attaches to ~/NR6q4V8w-report.csv), so same-named files never collide; the source document is never modified. Unknown, foreign, or malformed ids fail the request with a 400 before any command executes. Max 20 ids. | [
"or_file_011CNha8iCJcU1wXNR6q4V8w"
] | +| `networkPolicy` | *models.ContainerNetworkPolicy* | ➖ | Network egress policy for the container. "disabled" blocks all outbound internet; "allowlist" permits only hosts matching the listed hostnames or * glob patterns (ports 80/443, DNS via Cloudflare resolvers). The policy is fixed when a container starts: sending a different policy to a warm container fails the request with a 409. Omitted: defaults to "disabled" (no outbound internet). For unrestricted egress, use an allowlist of ["*"]. | \{
"allowed_domains": [
"pypi.org",
"files.pythonhosted.org"
],
"type": "allowlist"
} | +| `type` | *"container_reference"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contentcompaction.mdx b/docs/models/contentcompaction.mdx index a18ff2acf..0b6b79d55 100644 --- a/docs/models/contentcompaction.mdx +++ b/docs/models/contentcompaction.mdx @@ -17,7 +17,7 @@ let value: ContentCompaction = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `content` | *string* | :heavy_check_mark: | N/A | | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | -| `type` | *"compaction"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `content` | *string* | ✅ | N/A | | +| `encryptedContent` | *string* | ➖ | N/A | | +| `type` | *"compaction"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contentencryptedcontent.mdx b/docs/models/contentencryptedcontent.mdx index aa75742e7..81030eb56 100644 --- a/docs/models/contentencryptedcontent.mdx +++ b/docs/models/contentencryptedcontent.mdx @@ -17,6 +17,6 @@ let value: ContentEncryptedContent = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `encryptedContent` | *string* | :heavy_check_mark: | N/A | -| `type` | *"encrypted_content"* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `encryptedContent` | *string* | ✅ | N/A | +| `type` | *"encrypted_content"* | ✅ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/contentfilterbuiltinentry.mdx b/docs/models/contentfilterbuiltinentry.mdx index e089f67e8..7d2fbb985 100644 --- a/docs/models/contentfilterbuiltinentry.mdx +++ b/docs/models/contentfilterbuiltinentry.mdx @@ -19,7 +19,7 @@ let value: ContentFilterBuiltinEntry = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [models.ContentFilterBuiltinAction](../models/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | -| `label` | *string* | :heavy_minus_sign: | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | -| `scanScope` | [models.PromptInjectionScanScope](../models/promptinjectionscanscope.mdx) | :heavy_minus_sign: | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | -| `slug` | [models.ContentFilterBuiltinSlug](../models/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `action` | [models.ContentFilterBuiltinAction](../models/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | +| `label` | *string* | ➖ | Read-only, system-assigned redaction placeholder derived from the slug (e.g. "[EMAIL]", "[PHONE]"). Not settable by the caller. | [EMAIL] | +| `scanScope` | [models.PromptInjectionScanScope](../models/promptinjectionscanscope.mdx) | ➖ | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | +| `slug` | [models.ContentFilterBuiltinSlug](../models/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/contentfilterbuiltinentryinput.mdx b/docs/models/contentfilterbuiltinentryinput.mdx index 971e2cbe5..054deba2b 100644 --- a/docs/models/contentfilterbuiltinentryinput.mdx +++ b/docs/models/contentfilterbuiltinentryinput.mdx @@ -19,7 +19,7 @@ let value: ContentFilterBuiltinEntryInput = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [models.ContentFilterBuiltinAction](../models/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | -| ~~`label`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: labels are system-assigned and cannot be set by the caller. Accepted for backward compatibility but silently ignored. | | -| `scanScope` | [models.PromptInjectionScanScope](../models/promptinjectionscanscope.mdx) | :heavy_minus_sign: | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | -| `slug` | [models.ContentFilterBuiltinSlug](../models/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `action` | [models.ContentFilterBuiltinAction](../models/contentfilterbuiltinaction.mdx) | ✅ | Action taken when the builtin filter triggers | block | +| ~~`label`~~ | *string* | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: labels are system-assigned and cannot be set by the caller. Accepted for backward compatibility but silently ignored. | | +| `scanScope` | [models.PromptInjectionScanScope](../models/promptinjectionscanscope.mdx) | ➖ | Which message roles to scan for prompt injection. Only applies to the regex-prompt-injection builtin. Defaults to all_messages. | user_only | +| `slug` | [models.ContentFilterBuiltinSlug](../models/contentfilterbuiltinslug.mdx) | ✅ | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/contentfilterentry.mdx b/docs/models/contentfilterentry.mdx index 658343787..f441e7ab4 100644 --- a/docs/models/contentfilterentry.mdx +++ b/docs/models/contentfilterentry.mdx @@ -19,6 +19,6 @@ let value: ContentFilterEntry = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `action` | [models.ContentFilterAction](../models/contentfilteraction.mdx) | :heavy_check_mark: | Action taken when the pattern matches | block | -| `label` | *string* | :heavy_minus_sign: | Optional label used in redaction placeholders or error messages | [API_KEY] | -| `pattern` | *string* | :heavy_check_mark: | A regex pattern to match against request content | \b(sk-[a-zA-Z0-9]\{48})\b | \ No newline at end of file +| `action` | [models.ContentFilterAction](../models/contentfilteraction.mdx) | ✅ | Action taken when the pattern matches | block | +| `label` | *string* | ➖ | Optional label used in redaction placeholders or error messages | [API_KEY] | +| `pattern` | *string* | ✅ | A regex pattern to match against request content | \b(sk-[a-zA-Z0-9]\{48})\b | \ No newline at end of file diff --git a/docs/models/contentimageurl.mdx b/docs/models/contentimageurl.mdx index 39623dade..b684b2abb 100644 --- a/docs/models/contentimageurl.mdx +++ b/docs/models/contentimageurl.mdx @@ -19,5 +19,5 @@ let value: ContentImageURL = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `imageUrl` | [models.ContentImageUrlImageUrl](../models/contentimageurlimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | *"image_url"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [models.ContentImageUrlImageUrl](../models/contentimageurlimageurl.mdx) | ✅ | N/A | +| `type` | *"image_url"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentimageurlimageurl.mdx b/docs/models/contentimageurlimageurl.mdx index f3c3ccee5..695e57c58 100644 --- a/docs/models/contentimageurlimageurl.mdx +++ b/docs/models/contentimageurlimageurl.mdx @@ -16,4 +16,4 @@ let value: ContentImageUrlImageUrl = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentpartaddedevent.mdx b/docs/models/contentpartaddedevent.mdx index da148e925..163e2fe3f 100644 --- a/docs/models/contentpartaddedevent.mdx +++ b/docs/models/contentpartaddedevent.mdx @@ -26,9 +26,9 @@ let value: ContentPartAddedEvent = { | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `part` | *models.ContentPartAddedEventPart* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.content_part.added"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `contentIndex` | *number* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `part` | *models.ContentPartAddedEventPart* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.content_part.added"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentpartaudio.mdx b/docs/models/contentpartaudio.mdx index 5ec4b08dc..71ba3f2a8 100644 --- a/docs/models/contentpartaudio.mdx +++ b/docs/models/contentpartaudio.mdx @@ -19,5 +19,5 @@ let value: ContentPartAudio = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `audioUrl` | [models.AudioUrl](../models/audiourl.mdx) | :heavy_check_mark: | N/A | -| `type` | *"audio_url"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `audioUrl` | [models.AudioUrl](../models/audiourl.mdx) | ✅ | N/A | +| `type` | *"audio_url"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentpartdoneevent.mdx b/docs/models/contentpartdoneevent.mdx index db8e32cdc..6c5463638 100644 --- a/docs/models/contentpartdoneevent.mdx +++ b/docs/models/contentpartdoneevent.mdx @@ -26,9 +26,9 @@ let value: ContentPartDoneEvent = { | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `part` | *models.ContentPartDoneEventPart* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.content_part.done"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `contentIndex` | *number* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `part` | *models.ContentPartDoneEventPart* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.content_part.done"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentpartimage.mdx b/docs/models/contentpartimage.mdx index 711c5f2c0..a4efd16db 100644 --- a/docs/models/contentpartimage.mdx +++ b/docs/models/contentpartimage.mdx @@ -19,5 +19,5 @@ let value: ContentPartImage = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `imageUrl` | [models.ContentPartImageImageUrl](../models/contentpartimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.ContentPartImageType](../models/contentpartimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [models.ContentPartImageImageUrl](../models/contentpartimageimageurl.mdx) | ✅ | N/A | +| `type` | [models.ContentPartImageType](../models/contentpartimagetype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentpartimageimageurl.mdx b/docs/models/contentpartimageimageurl.mdx index 7bc31150d..09eaa69a3 100644 --- a/docs/models/contentpartimageimageurl.mdx +++ b/docs/models/contentpartimageimageurl.mdx @@ -16,4 +16,4 @@ let value: ContentPartImageImageUrl = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentpartinputaudio.mdx b/docs/models/contentpartinputaudio.mdx index efd28cccd..8ffd3e6e1 100644 --- a/docs/models/contentpartinputaudio.mdx +++ b/docs/models/contentpartinputaudio.mdx @@ -19,5 +19,5 @@ let value: ContentPartInputAudio = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `inputAudio` | [models.MultimodalMedia](../models/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `type` | *"input_audio"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `inputAudio` | [models.MultimodalMedia](../models/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `type` | *"input_audio"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contentpartinputfile.mdx b/docs/models/contentpartinputfile.mdx index 9e18f25b3..5446c90c0 100644 --- a/docs/models/contentpartinputfile.mdx +++ b/docs/models/contentpartinputfile.mdx @@ -19,5 +19,5 @@ let value: ContentPartInputFile = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `inputFile` | [models.MultimodalMedia](../models/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `type` | *"input_file"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `inputFile` | [models.MultimodalMedia](../models/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `type` | *"input_file"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contentpartinputvideo.mdx b/docs/models/contentpartinputvideo.mdx index d6310838a..9d788d9bd 100644 --- a/docs/models/contentpartinputvideo.mdx +++ b/docs/models/contentpartinputvideo.mdx @@ -19,5 +19,5 @@ let value: ContentPartInputVideo = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `inputVideo` | [models.MultimodalMedia](../models/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `type` | *"input_video"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `inputVideo` | [models.MultimodalMedia](../models/multimodalmedia.mdx) | ✅ | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `type` | *"input_video"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contentpartvideo.mdx b/docs/models/contentpartvideo.mdx index bb31d657c..71a973871 100644 --- a/docs/models/contentpartvideo.mdx +++ b/docs/models/contentpartvideo.mdx @@ -19,5 +19,5 @@ let value: ContentPartVideo = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | *"video_url"* | :heavy_check_mark: | N/A | -| `videoUrl` | [models.VideoUrl](../models/videourl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"video_url"* | ✅ | N/A | +| `videoUrl` | [models.VideoUrl](../models/videourl.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentredactedthinking.mdx b/docs/models/contentredactedthinking.mdx index d626247db..418a3cdac 100644 --- a/docs/models/contentredactedthinking.mdx +++ b/docs/models/contentredactedthinking.mdx @@ -17,5 +17,5 @@ let value: ContentRedactedThinking = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `data` | *string* | :heavy_check_mark: | N/A | -| `type` | *"redacted_thinking"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *string* | ✅ | N/A | +| `type` | *"redacted_thinking"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentservertooluse.mdx b/docs/models/contentservertooluse.mdx index 0039c0459..6a0ad52ec 100644 --- a/docs/models/contentservertooluse.mdx +++ b/docs/models/contentservertooluse.mdx @@ -18,8 +18,8 @@ let value: ContentServerToolUse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `input` | *any* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"server_tool_use"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `id` | *string* | ✅ | N/A | | +| `input` | *any* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `type` | *"server_tool_use"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contenttext.mdx b/docs/models/contenttext.mdx index 85fd43eae..2a3637708 100644 --- a/docs/models/contenttext.mdx +++ b/docs/models/contenttext.mdx @@ -17,5 +17,5 @@ let value: ContentText = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *string* | ✅ | N/A | +| `type` | *"text"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentthinking.mdx b/docs/models/contentthinking.mdx index 2452e7efb..3f62ce6bf 100644 --- a/docs/models/contentthinking.mdx +++ b/docs/models/contentthinking.mdx @@ -18,6 +18,6 @@ let value: ContentThinking = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `signature` | *string* | :heavy_check_mark: | N/A | -| `thinking` | *string* | :heavy_check_mark: | N/A | -| `type` | *"thinking"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `signature` | *string* | ✅ | N/A | +| `thinking` | *string* | ✅ | N/A | +| `type` | *"thinking"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contenttoolreference.mdx b/docs/models/contenttoolreference.mdx index 426501886..ea2293339 100644 --- a/docs/models/contenttoolreference.mdx +++ b/docs/models/contenttoolreference.mdx @@ -17,5 +17,5 @@ let value: ContentToolReference = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `toolName` | *string* | :heavy_check_mark: | N/A | -| `type` | *"tool_reference"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `toolName` | *string* | ✅ | N/A | +| `type` | *"tool_reference"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contenttoolresult.mdx b/docs/models/contenttoolresult.mdx index 45eddeac2..053ea8376 100644 --- a/docs/models/contenttoolresult.mdx +++ b/docs/models/contenttoolresult.mdx @@ -17,8 +17,8 @@ let value: ContentToolResult = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `content` | *models.MessagesMessageParamContentUnion2* | :heavy_minus_sign: | N/A | | -| `isError` | *boolean* | :heavy_minus_sign: | N/A | | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `content` | *models.MessagesMessageParamContentUnion2* | ➖ | N/A | | +| `isError` | *boolean* | ➖ | N/A | | +| `toolUseId` | *string* | ✅ | N/A | | +| `type` | *"tool_result"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contenttooluse.mdx b/docs/models/contenttooluse.mdx index b957b4de9..6cccdc53d 100644 --- a/docs/models/contenttooluse.mdx +++ b/docs/models/contenttooluse.mdx @@ -18,8 +18,8 @@ let value: ContentToolUse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `input` | *any* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"tool_use"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `id` | *string* | ✅ | N/A | | +| `input` | *any* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `type` | *"tool_use"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contenttoplogprob.mdx b/docs/models/contenttoplogprob.mdx index 6673dcba7..5f5ee6a53 100644 --- a/docs/models/contenttoplogprob.mdx +++ b/docs/models/contenttoplogprob.mdx @@ -22,6 +22,6 @@ let value: ContentTopLogprob = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes` | *number*[] | ✅ | N/A | +| `logprob` | *number* | ✅ | N/A | +| `token` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contentwebsearchtoolresult.mdx b/docs/models/contentwebsearchtoolresult.mdx index 1e26ba9de..9e5bfbb6e 100644 --- a/docs/models/contentwebsearchtoolresult.mdx +++ b/docs/models/contentwebsearchtoolresult.mdx @@ -25,7 +25,7 @@ let value: ContentWebSearchToolResult = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `content` | *models.MessagesMessageParamContentUnion3* | :heavy_check_mark: | N/A | | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"web_search_tool_result"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `content` | *models.MessagesMessageParamContentUnion3* | ✅ | N/A | | +| `toolUseId` | *string* | ✅ | N/A | | +| `type` | *"web_search_tool_result"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contentwebsearchtoolresulterror.mdx b/docs/models/contentwebsearchtoolresulterror.mdx index 1082ba6ad..fd87ad8c7 100644 --- a/docs/models/contentwebsearchtoolresulterror.mdx +++ b/docs/models/contentwebsearchtoolresulterror.mdx @@ -17,5 +17,5 @@ let value: ContentWebSearchToolResultError = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `errorCode` | [models.MessagesMessageParamErrorCode](../models/messagesmessageparamerrorcode.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.MessagesMessageParamTypeWebSearchToolResultError](../models/messagesmessageparamtypewebsearchtoolresulterror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `errorCode` | [models.MessagesMessageParamErrorCode](../models/messagesmessageparamerrorcode.mdx) | ✅ | N/A | +| `type` | [models.MessagesMessageParamTypeWebSearchToolResultError](../models/messagesmessageparamtypewebsearchtoolresulterror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/contextcompactionitem.mdx b/docs/models/contextcompactionitem.mdx index 76b698e2d..7f24932ed 100644 --- a/docs/models/contextcompactionitem.mdx +++ b/docs/models/contextcompactionitem.mdx @@ -18,7 +18,7 @@ let value: ContextCompactionItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.ContextCompactionItemType](../models/contextcompactionitemtype.mdx) | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file +| `encryptedContent` | *string* | ➖ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `type` | [models.ContextCompactionItemType](../models/contextcompactionitemtype.mdx) | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file diff --git a/docs/models/contextcompressionplugin.mdx b/docs/models/contextcompressionplugin.mdx index b4c2e677e..64a31d7d9 100644 --- a/docs/models/contextcompressionplugin.mdx +++ b/docs/models/contextcompressionplugin.mdx @@ -16,6 +16,6 @@ let value: ContextCompressionPlugin = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. | | -| `engine` | [models.ContextCompressionEngine](../models/contextcompressionengine.mdx) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | -| `id` | *"context-compression"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `enabled` | *boolean* | ➖ | Set to false to disable the context-compression plugin for this request. Defaults to true. | | +| `engine` | [models.ContextCompressionEngine](../models/contextcompressionengine.mdx) | ➖ | The compression engine to use. Defaults to "middle-out". | middle-out | +| `id` | *"context-compression"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/contextmanagement.mdx b/docs/models/contextmanagement.mdx index d9897be3f..0469e96c4 100644 --- a/docs/models/contextmanagement.mdx +++ b/docs/models/contextmanagement.mdx @@ -14,4 +14,4 @@ let value: ContextManagement = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `edits` | *models.Edit*[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `edits` | *models.Edit*[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/contradiction.mdx b/docs/models/contradiction.mdx index a29683fbb..698a2410e 100644 --- a/docs/models/contradiction.mdx +++ b/docs/models/contradiction.mdx @@ -22,5 +22,5 @@ let value: Contradiction = { | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `stances` | [models.Stance](../models/stance.mdx)[] | :heavy_check_mark: | N/A | -| `topic` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `stances` | [models.Stance](../models/stance.mdx)[] | ✅ | N/A | +| `topic` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/costdetails.mdx b/docs/models/costdetails.mdx index 502692824..5d12a65f6 100644 --- a/docs/models/costdetails.mdx +++ b/docs/models/costdetails.mdx @@ -19,7 +19,7 @@ let value: CostDetails = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `serverToolCost` | *number* | :heavy_minus_sign: | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | -| `upstreamInferenceCompletionsCost` | *number* | :heavy_check_mark: | N/A | -| `upstreamInferenceCost` | *number* | :heavy_minus_sign: | N/A | -| `upstreamInferencePromptCost` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `serverToolCost` | *number* | ➖ | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | +| `upstreamInferenceCompletionsCost` | *number* | ✅ | N/A | +| `upstreamInferenceCost` | *number* | ➖ | N/A | +| `upstreamInferencePromptCost` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/createbyokkeyrequest.mdx b/docs/models/createbyokkeyrequest.mdx index 41c765f37..aa9ae19c4 100644 --- a/docs/models/createbyokkeyrequest.mdx +++ b/docs/models/createbyokkeyrequest.mdx @@ -17,16 +17,16 @@ let value: CreateBYOKKeyRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedApiKeyHashes` | *string*[] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowedUserIds` | *string*[] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declaredRegion` | [models.CreateBYOKKeyRequestDeclaredRegion](../models/createbyokkeyrequestdeclaredregion.mdx) | :heavy_minus_sign: | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Defaults to the key's region for OpenAI and Fireworks, otherwise `null`. | null | -| `declaredZdr` | *boolean* | :heavy_minus_sign: | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Defaults to `null`. | null | -| `disabled` | *boolean* | :heavy_minus_sign: | Whether this credential should be created in a disabled state. | false | -| `isByokOnly` | *boolean* | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Defaults to `false`. | false | -| `isFallback` | *boolean* | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | -| `isRequired` | *boolean* | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Defaults to `false`. | false | -| `key` | *string* | :heavy_check_mark: | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | -| `name` | *string* | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `provider` | [models.BYOKProviderSlug](../models/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID to scope the credential to. When omitted, the credential is created in the account's default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `allowedApiKeyHashes` | *string*[] | ➖ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` means no restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `allowedModels` | *string*[] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowedUserIds` | *string*[] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declaredRegion` | [models.CreateBYOKKeyRequestDeclaredRegion](../models/createbyokkeyrequestdeclaredregion.mdx) | ➖ | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Defaults to the key's region for OpenAI and Fireworks, otherwise `null`. | null | +| `declaredZdr` | *boolean* | ➖ | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Defaults to `null`. | null | +| `disabled` | *boolean* | ➖ | Whether this credential should be created in a disabled state. | false | +| `isByokOnly` | *boolean* | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Defaults to `false`. | false | +| `isFallback` | *boolean* | ➖ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. | false | +| `isRequired` | *boolean* | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Defaults to `false`. | false | +| `key` | *string* | ✅ | The raw provider API key or credential. This value is encrypted at rest and never returned in API responses. | sk-proj-abc123... | +| `name` | *string* | ➖ | Optional human-readable name for the credential. | Production OpenAI Key | +| `provider` | [models.BYOKProviderSlug](../models/byokproviderslug.mdx) | ✅ | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `workspaceId` | *string* | ➖ | Optional workspace ID to scope the credential to. When omitted, the credential is created in the account's default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/createbyokkeyresponse.mdx b/docs/models/createbyokkeyresponse.mdx index 85ff57c5c..4425d3a80 100644 --- a/docs/models/createbyokkeyresponse.mdx +++ b/docs/models/createbyokkeyresponse.mdx @@ -32,4 +32,4 @@ let value: CreateBYOKKeyResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.BYOKKey](../models/byokkey.mdx) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `data` | [models.BYOKKey](../models/byokkey.mdx) | ✅ | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/createenduserrequest.mdx b/docs/models/createenduserrequest.mdx index 90851a656..0e66866d7 100644 --- a/docs/models/createenduserrequest.mdx +++ b/docs/models/createenduserrequest.mdx @@ -16,4 +16,4 @@ let value: CreateEndUserRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `user` | *string* | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file +| `user` | *string* | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file diff --git a/docs/models/createguardrailrequest.mdx b/docs/models/createguardrailrequest.mdx index fb1d7f322..d58526a45 100644 --- a/docs/models/createguardrailrequest.mdx +++ b/docs/models/createguardrailrequest.mdx @@ -16,25 +16,25 @@ let value: CreateGuardrailRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDataRegions` | [models.GuardrailDataRegion](../models/guardraildataregion.mdx)[] | :heavy_minus_sign: | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](../models/contentfilterbuiltinentryinput.mdx)[] | :heavy_minus_sign: | Builtin content filters to apply. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | -| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry.mdx)[] | :heavy_minus_sign: | Custom regex content filters to apply to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | -| `description` | *string* | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | -| `enableFreeModelPublication` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enableFreeModelTraining` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `enablePaidModelTraining` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`enforceZdr`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `enforceZdrAnthropic` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrGoogle` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrOpenai` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrOther` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrXai` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `ignoredModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignoredProviders` | *string*[] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `includeByokInBudgets` | *boolean* | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Defaults to false. | false | -| `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD. Must be provided together with `reset_interval`: a request that sets only one of the two is rejected with a 400. | 50 | -| `name` | *string* | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `workspaceId` | *string* | :heavy_minus_sign: | The workspace to create the guardrail in. When omitted, the guardrail is created in the default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. This only places the guardrail in the workspace; the created guardrail enforces nothing for that workspace's traffic until it is assigned to API keys or members. To restrict all traffic in a workspace, update the workspace's default guardrail instead. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `allowedDataRegions` | [models.GuardrailDataRegion](../models/guardraildataregion.mdx)[] | ➖ | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | +| `allowedModels` | *string*[] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | +| `allowedProviders` | *string*[] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](../models/contentfilterbuiltinentryinput.mdx)[] | ➖ | Builtin content filters to apply. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | +| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry.mdx)[] | ➖ | Custom regex content filters to apply to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | +| `description` | *string* | ➖ | Description of the guardrail | A guardrail for limiting API usage | +| `enableFreeModelPublication` | *boolean* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enableFreeModelTraining` | *boolean* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `enablePaidModelTraining` | *boolean* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`enforceZdr`~~ | *boolean* | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | +| `enforceZdrAnthropic` | *boolean* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `enforceZdrGoogle` | *boolean* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `enforceZdrOpenai` | *boolean* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `enforceZdrOther` | *boolean* | ➖ | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | +| `enforceZdrXai` | *boolean* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `ignoredModels` | *string*[] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignoredProviders` | *string*[] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `includeByokInBudgets` | *boolean* | ➖ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Defaults to false. | false | +| `limitUsd` | *number* | ➖ | Spending limit in USD. Must be provided together with `reset_interval`: a request that sets only one of the two is rejected with a 400. | 50 | +| `name` | *string* | ✅ | Name for the new guardrail | My New Guardrail | +| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `workspaceId` | *string* | ➖ | The workspace to create the guardrail in. When omitted, the guardrail is created in the default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. This only places the guardrail in the workspace; the created guardrail enforces nothing for that workspace's traffic until it is assigned to API keys or members. To restrict all traffic in a workspace, update the workspace's default guardrail instead. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/createguardrailresponse.mdx b/docs/models/createguardrailresponse.mdx index 47e18ab36..df46ac338 100644 --- a/docs/models/createguardrailresponse.mdx +++ b/docs/models/createguardrailresponse.mdx @@ -22,4 +22,4 @@ let value: CreateGuardrailResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Guardrail](../models/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `data` | [models.Guardrail](../models/guardrail.mdx) | ✅ | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/createinternrequest.mdx b/docs/models/createinternrequest.mdx index 90d9dfe6e..f0a21802a 100644 --- a/docs/models/createinternrequest.mdx +++ b/docs/models/createinternrequest.mdx @@ -19,9 +19,9 @@ let value: CreateInternRequest = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *string* | :heavy_minus_sign: | Free-form description, or null. | -| `instructions` | *string* | :heavy_minus_sign: | Standing instructions the intern boots with, or null. | -| `name` | *string* | :heavy_check_mark: | Intern name, unique per creator within the workspace. | -| `provision` | *boolean* | :heavy_minus_sign: | Start provisioning during this create operation. Defaults to false. | -| `vaultId` | *string* | :heavy_minus_sign: | Vault owned by another intern in this workspace to attach as a borrowed vault. | -| `workspaceId` | *string* | :heavy_minus_sign: | Workspace that will own the intern. Defaults to the workspace the API key resolves to. When given, it must match the API key workspace. | \ No newline at end of file +| `description` | *string* | ➖ | Free-form description, or null. | +| `instructions` | *string* | ➖ | Standing instructions the intern boots with, or null. | +| `name` | *string* | ✅ | Intern name, unique per creator within the workspace. | +| `provision` | *boolean* | ➖ | Start provisioning during this create operation. Defaults to false. | +| `vaultId` | *string* | ➖ | Vault owned by another intern in this workspace to attach as a borrowed vault. | +| `workspaceId` | *string* | ➖ | Workspace that will own the intern. Defaults to the workspace the API key resolves to. When given, it must match the API key workspace. | \ No newline at end of file diff --git a/docs/models/createobservabilitydestinationrequest.mdx b/docs/models/createobservabilitydestinationrequest.mdx index 86db79c59..a15171bd1 100644 --- a/docs/models/createobservabilitydestinationrequest.mdx +++ b/docs/models/createobservabilitydestinationrequest.mdx @@ -22,16 +22,16 @@ let value: CreateObservabilityDestinationRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_minus_sign: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_minus_sign: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_minus_sign: | When true, include request-context generation metadata. | false | -| `config` | Record\ | :heavy_check_mark: | Provider-specific configuration. The shape depends on `type` and is validated server-side. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | -| `enabled` | *boolean* | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfigNullable](../models/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | [models.ObservabilityDataRegionInput](../models/observabilitydataregioninput.mdx)[] | :heavy_minus_sign: | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field defaults to ['global']; the array must be non-empty. | [
"global"
] | -| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | [models.CreateObservabilityDestinationRequestType](../models/createobservabilitydestinationrequesttype.mdx) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | -| `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ➖ | Optional allowlist of OpenRouter API key hashes whose traffic is forwarded. `null` or omitted means all keys. Must contain at least one hash if provided. | null | +| `broadcastGenerationCost` | *boolean* | ➖ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ➖ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ➖ | When true, include request-context generation metadata. | false | +| `config` | Record\ | ✅ | Provider-specific configuration. The shape depends on `type` and is validated server-side. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | +| `enabled` | *boolean* | ➖ | Whether this destination should be enabled immediately. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfigNullable](../models/observabilityfilterrulesconfignullable.mdx) | ➖ | Optional structured filter rules controlling which events are forwarded. | null | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | [models.ObservabilityDataRegionInput](../models/observabilitydataregioninput.mdx)[] | ➖ | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field defaults to ['global']; the array must be non-empty. | [
"global"
] | +| `samplingRate` | *number* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | [models.CreateObservabilityDestinationRequestType](../models/createobservabilitydestinationrequesttype.mdx) | ✅ | The destination type. Only stable destination types are accepted. | langfuse | +| `workspaceId` | *string* | ➖ | Optional workspace ID. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/createobservabilitydestinationresponse.mdx b/docs/models/createobservabilitydestinationresponse.mdx index 4611927c7..c95dbc67b 100644 --- a/docs/models/createobservabilitydestinationresponse.mdx +++ b/docs/models/createobservabilitydestinationresponse.mdx @@ -39,4 +39,4 @@ let value: CreateObservabilityDestinationResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *models.ObservabilityDestination* | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `data` | *models.ObservabilityDestination* | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/createpresetfrominferenceresponse.mdx b/docs/models/createpresetfrominferenceresponse.mdx index 5d5ab8aae..d6684c36c 100644 --- a/docs/models/createpresetfrominferenceresponse.mdx +++ b/docs/models/createpresetfrominferenceresponse.mdx @@ -43,4 +43,4 @@ let value: CreatePresetFromInferenceResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.PresetWithDesignatedVersion](../models/presetwithdesignatedversion.mdx) | :heavy_check_mark: | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file +| `data` | [models.PresetWithDesignatedVersion](../models/presetwithdesignatedversion.mdx) | ✅ | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file diff --git a/docs/models/createprivateendpointrequest.mdx b/docs/models/createprivateendpointrequest.mdx index 18c19034d..b7ba0dc21 100644 --- a/docs/models/createprivateendpointrequest.mdx +++ b/docs/models/createprivateendpointrequest.mdx @@ -18,11 +18,11 @@ let value: CreatePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `activate` | [models.PrivateEndpointActivation](../models/privateendpointactivation.mdx) | :heavy_minus_sign: | Validate and activate in the same call. On a failed validation the draft is kept and returned with a 422, so fix it and call `/validate` and `/activate` instead of creating it again. | \{
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | -| `baseUrl` | *string* | :heavy_minus_sign: | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | -| `declaredRegion` | [models.CreatePrivateEndpointRequestDeclaredRegion](../models/createprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | -| `declaredZdr` | *boolean* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | -| `modelPermaslug` | *string* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `pricing` | [models.PrivateEndpointPricing](../models/privateendpointpricing.mdx) | :heavy_minus_sign: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `providerSlug` | *string* | :heavy_check_mark: | Slug of the upstream provider. | azure | -| `upstreamModelId` | *string* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `activate` | [models.PrivateEndpointActivation](../models/privateendpointactivation.mdx) | ➖ | Validate and activate in the same call. On a failed validation the draft is kept and returned with a 422, so fix it and call `/validate` and `/activate` instead of creating it again. | \{
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | +| `baseUrl` | *string* | ➖ | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | +| `declaredRegion` | [models.CreatePrivateEndpointRequestDeclaredRegion](../models/createprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | +| `declaredZdr` | *boolean* | ➖ | Attest that this deployment retains no prompt or completion data. | | +| `modelPermaslug` | *string* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `pricing` | [models.PrivateEndpointPricing](../models/privateendpointpricing.mdx) | ➖ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `providerSlug` | *string* | ✅ | Slug of the upstream provider. | azure | +| `upstreamModelId` | *string* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/models/createprivateendpointvalidationfailedresponsedata.mdx b/docs/models/createprivateendpointvalidationfailedresponsedata.mdx index 15fb6a0fb..ae38f8a5f 100644 --- a/docs/models/createprivateendpointvalidationfailedresponsedata.mdx +++ b/docs/models/createprivateendpointvalidationfailedresponsedata.mdx @@ -35,5 +35,5 @@ let value: CreatePrivateEndpointValidationFailedResponseData = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `endpoint` | [models.ManagedPrivateEndpoint](../models/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | -| `validation` | [models.PrivateEndpointValidationNullable](../models/privateendpointvalidationnullable.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `endpoint` | [models.ManagedPrivateEndpoint](../models/managedprivateendpoint.mdx) | ✅ | N/A | +| `validation` | [models.PrivateEndpointValidationNullable](../models/privateendpointvalidationnullable.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/createprivateendpointvalidationfailedresponseerror.mdx b/docs/models/createprivateendpointvalidationfailedresponseerror.mdx index 0e81205ba..67dda8605 100644 --- a/docs/models/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/models/createprivateendpointvalidationfailedresponseerror.mdx @@ -17,5 +17,5 @@ let value: CreatePrivateEndpointValidationFailedResponseError = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/createscimgroupmappingrequest.mdx b/docs/models/createscimgroupmappingrequest.mdx index 26aacb96b..b970698b0 100644 --- a/docs/models/createscimgroupmappingrequest.mdx +++ b/docs/models/createscimgroupmappingrequest.mdx @@ -18,6 +18,6 @@ let value: CreateScimGroupMappingRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `role` | [models.CreateScimGroupMappingRequestRole](../models/createscimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | -| `scimGroupId` | *string* | :heavy_check_mark: | N/A | -| `workspaceId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `role` | [models.CreateScimGroupMappingRequestRole](../models/createscimgroupmappingrequestrole.mdx) | ✅ | N/A | +| `scimGroupId` | *string* | ✅ | N/A | +| `workspaceId` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/createscimgroupmappingresponse.mdx b/docs/models/createscimgroupmappingresponse.mdx index 5c0465f04..37add6fa3 100644 --- a/docs/models/createscimgroupmappingresponse.mdx +++ b/docs/models/createscimgroupmappingresponse.mdx @@ -24,4 +24,4 @@ let value: CreateScimGroupMappingResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.ScimGroupMapping](../models/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `data` | [models.ScimGroupMapping](../models/scimgroupmapping.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/createscimsyncjobresponse.mdx b/docs/models/createscimsyncjobresponse.mdx index 0f4494f40..f2aaaf469 100644 --- a/docs/models/createscimsyncjobresponse.mdx +++ b/docs/models/createscimsyncjobresponse.mdx @@ -25,4 +25,4 @@ let value: CreateScimSyncJobResponse = { | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `data` | [models.ScimSyncJob](../models/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.ScimSyncJob](../models/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/createworkspacerequest.mdx b/docs/models/createworkspacerequest.mdx index b55156545..c931a9ad7 100644 --- a/docs/models/createworkspacerequest.mdx +++ b/docs/models/createworkspacerequest.mdx @@ -17,15 +17,15 @@ let value: CreateWorkspaceRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `defaultImageModel` | *string* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `defaultProviderSort` | *string* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `defaultTextModel` | *string* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *string* | :heavy_minus_sign: | Description of the workspace | Production environment workspace | -| `disabledServerTools` | [models.CreateWorkspaceRequestDisabledServerTool](../models/createworkspacerequestdisabledservertool.mdx)[] | :heavy_minus_sign: | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | -| `ioLoggingApiKeyIds` | *number*[] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | -| `ioLoggingSamplingRate` | *number* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `isDataDiscountLoggingEnabled` | *boolean* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `isObservabilityBroadcastEnabled` | *boolean* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `isObservabilityIoLoggingEnabled` | *boolean* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *string* | :heavy_check_mark: | Name for the new workspace | Production | -| `slug` | *string* | :heavy_check_mark: | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file +| `defaultImageModel` | *string* | ➖ | Default image model for this workspace | openai/dall-e-3 | +| `defaultProviderSort` | *string* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `defaultTextModel` | *string* | ➖ | Default text model for this workspace | openai/gpt-4o | +| `description` | *string* | ➖ | Description of the workspace | Production environment workspace | +| `disabledServerTools` | [models.CreateWorkspaceRequestDisabledServerTool](../models/createworkspacerequestdisabledservertool.mdx)[] | ➖ | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | +| `ioLoggingApiKeyIds` | *number*[] | ➖ | Optional array of API key IDs to filter I/O logging | null | +| `ioLoggingSamplingRate` | *number* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | +| `isDataDiscountLoggingEnabled` | *boolean* | ➖ | Whether data discount logging is enabled | true | +| `isObservabilityBroadcastEnabled` | *boolean* | ➖ | Whether broadcast is enabled | false | +| `isObservabilityIoLoggingEnabled` | *boolean* | ➖ | Whether private logging is enabled | false | +| `name` | *string* | ✅ | Name for the new workspace | Production | +| `slug` | *string* | ✅ | URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | production | \ No newline at end of file diff --git a/docs/models/createworkspaceresponse.mdx b/docs/models/createworkspaceresponse.mdx index 4503bec2d..df14f599e 100644 --- a/docs/models/createworkspaceresponse.mdx +++ b/docs/models/createworkspaceresponse.mdx @@ -33,4 +33,4 @@ let value: CreateWorkspaceResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Workspace](../models/workspace.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file +| `data` | [models.Workspace](../models/workspace.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/customtool.mdx b/docs/models/customtool.mdx index 83a783e3e..96981a7b1 100644 --- a/docs/models/customtool.mdx +++ b/docs/models/customtool.mdx @@ -19,8 +19,8 @@ let value: CustomTool = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `async` | *boolean* | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `description` | *string* | :heavy_minus_sign: | N/A | | -| `format` | *models.Format* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.CustomToolTypeCustom](../models/customtooltypecustom.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async` | *boolean* | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `description` | *string* | ➖ | N/A | | +| `format` | *models.Format* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `type` | [models.CustomToolTypeCustom](../models/customtooltypecustom.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/customtoolcallinputdeltaevent.mdx b/docs/models/customtoolcallinputdeltaevent.mdx index b72a7bb7a..e2e35f3d6 100644 --- a/docs/models/customtoolcallinputdeltaevent.mdx +++ b/docs/models/customtoolcallinputdeltaevent.mdx @@ -22,8 +22,8 @@ let value: CustomToolCallInputDeltaEvent = { | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.custom_tool_call_input.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.custom_tool_call_input.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/customtoolcallinputdoneevent.mdx b/docs/models/customtoolcallinputdoneevent.mdx index 7c39777a9..5da4b1143 100644 --- a/docs/models/customtoolcallinputdoneevent.mdx +++ b/docs/models/customtoolcallinputdoneevent.mdx @@ -22,8 +22,8 @@ let value: CustomToolCallInputDoneEvent = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `input` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.custom_tool_call_input.done"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `input` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.custom_tool_call_input.done"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/customtoolcallitem.mdx b/docs/models/customtoolcallitem.mdx index 575032459..bece21a52 100644 --- a/docs/models/customtoolcallitem.mdx +++ b/docs/models/customtoolcallitem.mdx @@ -21,11 +21,11 @@ let value: CustomToolCallItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `async` | *boolean* | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `input` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.CustomToolCallItemType](../models/customtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async` | *boolean* | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `input` | *string* | ✅ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `namespace` | *string* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [models.CustomToolCallItemType](../models/customtoolcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/customtoolcalloutputitem.mdx b/docs/models/customtoolcalloutputitem.mdx index d9de4b91f..6ff83ff65 100644 --- a/docs/models/customtoolcalloutputitem.mdx +++ b/docs/models/customtoolcalloutputitem.mdx @@ -20,7 +20,7 @@ let value: CustomToolCallOutputItem = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `output` | *models.CustomToolCallOutputItemOutputUnion2* | :heavy_check_mark: | N/A | -| `type` | [models.CustomToolCallOutputItemTypeCustomToolCallOutput](../models/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | +| `id` | *string* | ➖ | N/A | +| `output` | *models.CustomToolCallOutputItemOutputUnion2* | ✅ | N/A | +| `type` | [models.CustomToolCallOutputItemTypeCustomToolCallOutput](../models/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/customtoolcalloutputitemoutputinputimage.mdx b/docs/models/customtoolcalloutputitemoutputinputimage.mdx index 786a4867f..bc1e8d871 100644 --- a/docs/models/customtoolcalloutputitemoutputinputimage.mdx +++ b/docs/models/customtoolcalloutputitemoutputinputimage.mdx @@ -19,7 +19,7 @@ let value: CustomToolCallOutputItemOutputInputImage = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `detail` | [models.CustomToolCallOutputItemDetail](../models/customtoolcalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [models.CustomToolCallOutputItemDetail](../models/customtoolcalloutputitemdetail.mdx) | ✅ | N/A | +| `fileId` | *string* | ➖ | N/A | +| `imageUrl` | *string* | ➖ | N/A | +| `type` | *"input_image"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/dabenchmarkentry.mdx b/docs/models/dabenchmarkentry.mdx index d3113a3d5..8138a5c9c 100644 --- a/docs/models/dabenchmarkentry.mdx +++ b/docs/models/dabenchmarkentry.mdx @@ -22,8 +22,8 @@ let value: DABenchmarkEntry = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `arena` | *string* | :heavy_check_mark: | Arena type (e.g. models, builders, agents) | models | -| `category` | *string* | :heavy_check_mark: | Category within the arena (e.g. website, gamedev, uicomponent) | website | -| `elo` | *number* | :heavy_check_mark: | ELO rating from head-to-head arena battles | 1385.2 | -| `rank` | *number* | :heavy_check_mark: | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | -| `winRate` | *number* | :heavy_check_mark: | Win rate percentage in arena battles | 62.5 | \ No newline at end of file +| `arena` | *string* | ✅ | Arena type (e.g. models, builders, agents) | models | +| `category` | *string* | ✅ | Category within the arena (e.g. website, gamedev, uicomponent) | website | +| `elo` | *number* | ✅ | ELO rating from head-to-head arena battles | 1385.2 | +| `rank` | *number* | ✅ | Rank position within this arena+category among models available on OpenRouter (1 = highest ELO) | 5 | +| `winRate` | *number* | ✅ | Win rate percentage in arena battles | 62.5 | \ No newline at end of file diff --git a/docs/models/datetimeservertool.mdx b/docs/models/datetimeservertool.mdx index e35bc82ca..edead8790 100644 --- a/docs/models/datetimeservertool.mdx +++ b/docs/models/datetimeservertool.mdx @@ -18,5 +18,5 @@ let value: DatetimeServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `parameters` | [models.DatetimeServerToolConfig](../models/datetimeservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | -| `type` | [models.DatetimeServerToolType](../models/datetimeservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.DatetimeServerToolConfig](../models/datetimeservertoolconfig.mdx) | ➖ | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | +| `type` | [models.DatetimeServerToolType](../models/datetimeservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/datetimeservertoolconfig.mdx b/docs/models/datetimeservertoolconfig.mdx index 553c13259..d40dc401c 100644 --- a/docs/models/datetimeservertoolconfig.mdx +++ b/docs/models/datetimeservertoolconfig.mdx @@ -16,4 +16,4 @@ let value: DatetimeServerToolConfig = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `timezone` | *string* | :heavy_minus_sign: | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file +| `timezone` | *string* | ➖ | IANA timezone name (e.g. "America/New_York"). Defaults to UTC. | America/New_York | \ No newline at end of file diff --git a/docs/models/debugevent.mdx b/docs/models/debugevent.mdx index 9a76591e0..12adb4fb6 100644 --- a/docs/models/debugevent.mdx +++ b/docs/models/debugevent.mdx @@ -20,6 +20,6 @@ let value: DebugEvent = { | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `debug` | [models.DebugEventDebug](../models/debugeventdebug.mdx) | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.debug"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `debug` | [models.DebugEventDebug](../models/debugeventdebug.mdx) | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.debug"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/debugeventdebug.mdx b/docs/models/debugeventdebug.mdx index 2bf8f4069..65bf3c7af 100644 --- a/docs/models/debugeventdebug.mdx +++ b/docs/models/debugeventdebug.mdx @@ -14,5 +14,5 @@ let value: DebugEventDebug = {}; | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `echoUpstreamBody` | Record\ | :heavy_minus_sign: | N/A | -| `timings` | [models.DebugEventTimings](../models/debugeventtimings.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `echoUpstreamBody` | Record\ | ➖ | N/A | +| `timings` | [models.DebugEventTimings](../models/debugeventtimings.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/debugeventtimings.mdx b/docs/models/debugeventtimings.mdx index 2e71aac79..41dc9a14d 100644 --- a/docs/models/debugeventtimings.mdx +++ b/docs/models/debugeventtimings.mdx @@ -18,6 +18,6 @@ let value: DebugEventTimings = { | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `epochMs` | *number* | :heavy_check_mark: | N/A | -| `event` | [models.DebugEventEvent](../models/debugeventevent.mdx) | :heavy_check_mark: | N/A | -| `startMs` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `epochMs` | *number* | ✅ | N/A | +| `event` | [models.DebugEventEvent](../models/debugeventevent.mdx) | ✅ | N/A | +| `startMs` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/decisions.mdx b/docs/models/decisions.mdx index b1ec1d322..c81bac3f5 100644 --- a/docs/models/decisions.mdx +++ b/docs/models/decisions.mdx @@ -28,6 +28,6 @@ let value: Decisions = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `requestCount` | *number* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `requestCount` | *number* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/decisionschoiceanswer.mdx b/docs/models/decisionschoiceanswer.mdx index 210405420..7167adc21 100644 --- a/docs/models/decisionschoiceanswer.mdx +++ b/docs/models/decisionschoiceanswer.mdx @@ -17,7 +17,7 @@ let value: DecisionsChoiceAnswer = { | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `choice` | *string* | :heavy_check_mark: | N/A | -| `confidence` | *number* | :heavy_minus_sign: | N/A | -| `probabilities` | Record\ | :heavy_minus_sign: | N/A | -| `type` | *"choice"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `choice` | *string* | ✅ | N/A | +| `confidence` | *number* | ➖ | N/A | +| `probabilities` | Record\ | ➖ | N/A | +| `type` | *"choice"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/decisionschoicequestion.mdx b/docs/models/decisionschoicequestion.mdx index 2b47afe40..3c7615696 100644 --- a/docs/models/decisionschoicequestion.mdx +++ b/docs/models/decisionschoicequestion.mdx @@ -24,6 +24,6 @@ let value: DecisionsChoiceQuestion = { | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `criteria` | Record\ | :heavy_check_mark: | N/A | -| `instructions` | *models.DecisionsChoiceQuestionInstructions* | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `type` | *"choice"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `criteria` | Record\ | ✅ | N/A | +| `instructions` | *models.DecisionsChoiceQuestionInstructions* | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `type` | *"choice"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/decisionsnoulanswer.mdx b/docs/models/decisionsnoulanswer.mdx index 78f60089d..66b3d073f 100644 --- a/docs/models/decisionsnoulanswer.mdx +++ b/docs/models/decisionsnoulanswer.mdx @@ -17,5 +17,5 @@ let value: DecisionsNoulAnswer = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `noul` | *number* | :heavy_check_mark: | N/A | -| `type` | *"noul"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `noul` | *number* | ✅ | N/A | +| `type` | *"noul"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/decisionsnoulquestion.mdx b/docs/models/decisionsnoulquestion.mdx index 12b5f5f5c..ccf2d7170 100644 --- a/docs/models/decisionsnoulquestion.mdx +++ b/docs/models/decisionsnoulquestion.mdx @@ -17,6 +17,6 @@ let value: DecisionsNoulQuestion = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `criteria` | [models.DecisionsNoulQuestionCriteria](../models/decisionsnoulquestioncriteria.mdx) | :heavy_minus_sign: | N/A | -| `instructions` | *models.DecisionsNoulQuestionInstructions* | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `type` | *"noul"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `criteria` | [models.DecisionsNoulQuestionCriteria](../models/decisionsnoulquestioncriteria.mdx) | ➖ | N/A | +| `instructions` | *models.DecisionsNoulQuestionInstructions* | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `type` | *"noul"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/decisionsnoulquestioncriteria.mdx b/docs/models/decisionsnoulquestioncriteria.mdx index d67422247..7c18d4cdf 100644 --- a/docs/models/decisionsnoulquestioncriteria.mdx +++ b/docs/models/decisionsnoulquestioncriteria.mdx @@ -20,5 +20,5 @@ let value: DecisionsNoulQuestionCriteria = { | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `false` | *models.False* | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `true` | *models.True* | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | \ No newline at end of file +| `false` | *models.False* | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `true` | *models.True* | ✅ | A plain string, or a JSON object or array of structured guidance. | \ No newline at end of file diff --git a/docs/models/decisionsrequest.mdx b/docs/models/decisionsrequest.mdx index 416f114e2..9eb866d79 100644 --- a/docs/models/decisionsrequest.mdx +++ b/docs/models/decisionsrequest.mdx @@ -20,10 +20,10 @@ let value: DecisionsRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `provider` | [models.ProviderPreferences](../models/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `questions` | Record\ | :heavy_check_mark: | N/A | | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `state` | *models.State* | :heavy_check_mark: | The content to evaluate: a plain string, or a JSON object or array of related context. | | -| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `user` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `model` | *string* | ✅ | N/A | | +| `provider` | [models.ProviderPreferences](../models/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `questions` | Record\ | ✅ | N/A | | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `state` | *models.State* | ✅ | The content to evaluate: a plain string, or a JSON object or array of related context. | | +| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `user` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/decisionsresponse.mdx b/docs/models/decisionsresponse.mdx index 3bf2ecadd..3a2250144 100644 --- a/docs/models/decisionsresponse.mdx +++ b/docs/models/decisionsresponse.mdx @@ -21,8 +21,8 @@ let value: DecisionsResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `answers` | Record\ | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `provider` | *string* | :heavy_minus_sign: | N/A | -| `usage` | [models.DecisionsResponseUsage](../models/decisionsresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `answers` | Record\ | ✅ | N/A | +| `id` | *string* | ➖ | N/A | +| `model` | *string* | ✅ | N/A | +| `provider` | *string* | ➖ | N/A | +| `usage` | [models.DecisionsResponseUsage](../models/decisionsresponseusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/decisionsresponseusage.mdx b/docs/models/decisionsresponseusage.mdx index 56d1c7bbe..9671ad1e3 100644 --- a/docs/models/decisionsresponseusage.mdx +++ b/docs/models/decisionsresponseusage.mdx @@ -17,6 +17,6 @@ let value: DecisionsResponseUsage = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `cost` | *number* | :heavy_minus_sign: | N/A | -| `inputTokens` | *number* | :heavy_check_mark: | N/A | -| `outputTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `cost` | *number* | ➖ | N/A | +| `inputTokens` | *number* | ✅ | N/A | +| `outputTokens` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/decisionsscoreanswer.mdx b/docs/models/decisionsscoreanswer.mdx index 7bc4ad736..13e4891b9 100644 --- a/docs/models/decisionsscoreanswer.mdx +++ b/docs/models/decisionsscoreanswer.mdx @@ -17,8 +17,8 @@ let value: DecisionsScoreAnswer = { | Field | Type | Required | Description | | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | -| `confidence` | *number* | :heavy_minus_sign: | N/A | -| `legend` | Record\ | :heavy_minus_sign: | N/A | -| `probabilities` | Record\ | :heavy_minus_sign: | N/A | -| `score` | *number* | :heavy_check_mark: | N/A | -| `type` | *"score"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `confidence` | *number* | ➖ | N/A | +| `legend` | Record\ | ➖ | N/A | +| `probabilities` | Record\ | ➖ | N/A | +| `score` | *number* | ✅ | N/A | +| `type` | *"score"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/decisionsscorequestion.mdx b/docs/models/decisionsscorequestion.mdx index 6f39bbdca..686b18eac 100644 --- a/docs/models/decisionsscorequestion.mdx +++ b/docs/models/decisionsscorequestion.mdx @@ -22,6 +22,6 @@ let value: DecisionsScoreQuestion = { | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `criteria` | *models.Criterion*[] | :heavy_check_mark: | N/A | -| `instructions` | *models.DecisionsScoreQuestionInstructions* | :heavy_check_mark: | A plain string, or a JSON object or array of structured guidance. | -| `type` | *"score"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `criteria` | *models.Criterion*[] | ✅ | N/A | +| `instructions` | *models.DecisionsScoreQuestionInstructions* | ✅ | A plain string, or a JSON object or array of structured guidance. | +| `type` | *"score"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/defaultparameters.mdx b/docs/models/defaultparameters.mdx index 80ed9f2e2..5d2d9c2f3 100644 --- a/docs/models/defaultparameters.mdx +++ b/docs/models/defaultparameters.mdx @@ -16,9 +16,9 @@ let value: DefaultParameters = {}; | Field | Type | Required | Description | | ------------------- | ------------------- | ------------------- | ------------------- | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | -| `repetitionPenalty` | *number* | :heavy_minus_sign: | N/A | -| `temperature` | *number* | :heavy_minus_sign: | N/A | -| `topK` | *number* | :heavy_minus_sign: | N/A | -| `topP` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `frequencyPenalty` | *number* | ➖ | N/A | +| `presencePenalty` | *number* | ➖ | N/A | +| `repetitionPenalty` | *number* | ➖ | N/A | +| `temperature` | *number* | ➖ | N/A | +| `topK` | *number* | ➖ | N/A | +| `topP` | *number* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/deletebyokkeyresponse.mdx b/docs/models/deletebyokkeyresponse.mdx index c923cfd39..8cc6e7879 100644 --- a/docs/models/deletebyokkeyresponse.mdx +++ b/docs/models/deletebyokkeyresponse.mdx @@ -16,4 +16,4 @@ let value: DeleteBYOKKeyResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file +| `deleted` | *true* | ✅ | Confirmation that the BYOK credential was deleted. | true | \ No newline at end of file diff --git a/docs/models/deleteguardrailresponse.mdx b/docs/models/deleteguardrailresponse.mdx index e535ca316..96ef3d154 100644 --- a/docs/models/deleteguardrailresponse.mdx +++ b/docs/models/deleteguardrailresponse.mdx @@ -16,4 +16,4 @@ let value: DeleteGuardrailResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the guardrail was deleted | true | \ No newline at end of file +| `deleted` | *true* | ✅ | Confirmation that the guardrail was deleted | true | \ No newline at end of file diff --git a/docs/models/deleteinternrequest.mdx b/docs/models/deleteinternrequest.mdx index cc5af0e0d..a33bfd541 100644 --- a/docs/models/deleteinternrequest.mdx +++ b/docs/models/deleteinternrequest.mdx @@ -18,4 +18,4 @@ let value: DeleteInternRequest = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `acknowledgeWorkspaceLoss` | *boolean* | :heavy_minus_sign: | Delete even though the workspace backup was not confirmed. Defaults to false, which refuses the teardown when a workspace archive is missing. | \ No newline at end of file +| `acknowledgeWorkspaceLoss` | *boolean* | ➖ | Delete even though the workspace backup was not confirmed. Defaults to false, which refuses the teardown when a workspace archive is missing. | \ No newline at end of file diff --git a/docs/models/deleteinternresponse.mdx b/docs/models/deleteinternresponse.mdx index 297591041..258976b3c 100644 --- a/docs/models/deleteinternresponse.mdx +++ b/docs/models/deleteinternresponse.mdx @@ -16,4 +16,4 @@ let value: DeleteInternResponse = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `deleting` | *true* | :heavy_check_mark: | N/A | \ No newline at end of file +| `deleting` | *true* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/deleteobservabilitydestinationresponse.mdx b/docs/models/deleteobservabilitydestinationresponse.mdx index 788f496e1..e0a6de2a9 100644 --- a/docs/models/deleteobservabilitydestinationresponse.mdx +++ b/docs/models/deleteobservabilitydestinationresponse.mdx @@ -16,4 +16,4 @@ let value: DeleteObservabilityDestinationResponse = { | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Always `true` on success. | \ No newline at end of file +| `deleted` | *true* | ✅ | Always `true` on success. | \ No newline at end of file diff --git a/docs/models/deleteprivateendpointresponse.mdx b/docs/models/deleteprivateendpointresponse.mdx index fe84465d3..c267c22cf 100644 --- a/docs/models/deleteprivateendpointresponse.mdx +++ b/docs/models/deleteprivateendpointresponse.mdx @@ -18,4 +18,4 @@ let value: DeletePrivateEndpointResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `data` | [models.DeletePrivateEndpointResponseData](../models/deleteprivateendpointresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.DeletePrivateEndpointResponseData](../models/deleteprivateendpointresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/deleteprivateendpointresponsedata.mdx b/docs/models/deleteprivateendpointresponsedata.mdx index 31d2be37b..94ed64870 100644 --- a/docs/models/deleteprivateendpointresponsedata.mdx +++ b/docs/models/deleteprivateendpointresponsedata.mdx @@ -16,4 +16,4 @@ let value: DeletePrivateEndpointResponseData = { | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/deletescimgroupmappingresponse.mdx b/docs/models/deletescimgroupmappingresponse.mdx index d5612ee0e..b4beb60f4 100644 --- a/docs/models/deletescimgroupmappingresponse.mdx +++ b/docs/models/deletescimgroupmappingresponse.mdx @@ -16,4 +16,4 @@ let value: DeleteScimGroupMappingResponse = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `deleted` | *true* | :heavy_check_mark: | N/A | \ No newline at end of file +| `deleted` | *true* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/deleteworkspacebudgetresponse.mdx b/docs/models/deleteworkspacebudgetresponse.mdx index d65f0f6bc..5cde501c0 100644 --- a/docs/models/deleteworkspacebudgetresponse.mdx +++ b/docs/models/deleteworkspacebudgetresponse.mdx @@ -16,4 +16,4 @@ let value: DeleteWorkspaceBudgetResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file +| `deleted` | *true* | ✅ | Confirmation that the budget was deleted (or did not exist) | true | \ No newline at end of file diff --git a/docs/models/deleteworkspaceresponse.mdx b/docs/models/deleteworkspaceresponse.mdx index fd97d8b95..168054f16 100644 --- a/docs/models/deleteworkspaceresponse.mdx +++ b/docs/models/deleteworkspaceresponse.mdx @@ -16,4 +16,4 @@ let value: DeleteWorkspaceResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the workspace was deleted | true | \ No newline at end of file +| `deleted` | *true* | ✅ | Confirmation that the workspace was deleted | true | \ No newline at end of file diff --git a/docs/models/easyinputmessage.mdx b/docs/models/easyinputmessage.mdx index 43ebca4bb..77a6498e3 100644 --- a/docs/models/easyinputmessage.mdx +++ b/docs/models/easyinputmessage.mdx @@ -16,7 +16,7 @@ let value: EasyInputMessage = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.EasyInputMessageContentUnion2* | :heavy_minus_sign: | N/A | | -| `phase` | *models.EasyInputMessagePhaseUnion* | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer | -| `role` | *models.EasyInputMessageRoleUnion* | :heavy_check_mark: | N/A | | -| `type` | [models.EasyInputMessageTypeMessage](../models/easyinputmessagetypemessage.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `content` | *models.EasyInputMessageContentUnion2* | ➖ | N/A | | +| `phase` | *models.EasyInputMessagePhaseUnion* | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | final_answer | +| `role` | *models.EasyInputMessageRoleUnion* | ✅ | N/A | | +| `type` | [models.EasyInputMessageTypeMessage](../models/easyinputmessagetypemessage.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/easyinputmessagecontentinputimage.mdx b/docs/models/easyinputmessagecontentinputimage.mdx index b8822427f..3f7d1cd40 100644 --- a/docs/models/easyinputmessagecontentinputimage.mdx +++ b/docs/models/easyinputmessagecontentinputimage.mdx @@ -19,7 +19,7 @@ let value: EasyInputMessageContentInputImage = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `detail` | [models.EasyInputMessageDetail](../models/easyinputmessagedetail.mdx) | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [models.EasyInputMessageDetail](../models/easyinputmessagedetail.mdx) | ✅ | N/A | +| `fileId` | *string* | ➖ | N/A | +| `imageUrl` | *string* | ➖ | N/A | +| `type` | *"input_image"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/edgenetworktimeoutresponseerrordata.mdx b/docs/models/edgenetworktimeoutresponseerrordata.mdx index 24e80aa6f..f487c2301 100644 --- a/docs/models/edgenetworktimeoutresponseerrordata.mdx +++ b/docs/models/edgenetworktimeoutresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: EdgeNetworkTimeoutResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/editclearthinking20251015.mdx b/docs/models/editclearthinking20251015.mdx index 2f8f765ce..f46734f6f 100644 --- a/docs/models/editclearthinking20251015.mdx +++ b/docs/models/editclearthinking20251015.mdx @@ -16,5 +16,5 @@ let value: EditClearThinking20251015 = { | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `keep` | *models.Keep* | :heavy_minus_sign: | N/A | -| `type` | *"clear_thinking_20251015"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `keep` | *models.Keep* | ➖ | N/A | +| `type` | *"clear_thinking_20251015"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/editcleartooluses20250919.mdx b/docs/models/editcleartooluses20250919.mdx index 1981aa582..61633b6a2 100644 --- a/docs/models/editcleartooluses20250919.mdx +++ b/docs/models/editcleartooluses20250919.mdx @@ -16,9 +16,9 @@ let value: EditClearToolUses20250919 = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `clearAtLeast` | [models.AnthropicInputTokensClearAtLeast](../models/anthropicinputtokensclearatleast.mdx) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 50000
} | -| `clearToolInputs` | *models.ClearToolInputs* | :heavy_minus_sign: | N/A | | -| `excludeTools` | *string*[] | :heavy_minus_sign: | N/A | | -| `keep` | [models.AnthropicToolUsesKeep](../models/anthropictooluseskeep.mdx) | :heavy_minus_sign: | N/A | \{
"type": "tool_uses",
"value": 5
} | -| `trigger` | *models.Trigger* | :heavy_minus_sign: | N/A | | -| `type` | *"clear_tool_uses_20250919"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `clearAtLeast` | [models.AnthropicInputTokensClearAtLeast](../models/anthropicinputtokensclearatleast.mdx) | ➖ | N/A | \{
"type": "input_tokens",
"value": 50000
} | +| `clearToolInputs` | *models.ClearToolInputs* | ➖ | N/A | | +| `excludeTools` | *string*[] | ➖ | N/A | | +| `keep` | [models.AnthropicToolUsesKeep](../models/anthropictooluseskeep.mdx) | ➖ | N/A | \{
"type": "tool_uses",
"value": 5
} | +| `trigger` | *models.Trigger* | ➖ | N/A | | +| `type` | *"clear_tool_uses_20250919"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/editcompact20260112.mdx b/docs/models/editcompact20260112.mdx index fcb43b4d8..490bdf165 100644 --- a/docs/models/editcompact20260112.mdx +++ b/docs/models/editcompact20260112.mdx @@ -16,7 +16,7 @@ let value: EditCompact20260112 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `instructions` | *string* | :heavy_minus_sign: | N/A | | -| `pauseAfterCompaction` | *boolean* | :heavy_minus_sign: | N/A | | -| `trigger` | [models.TriggerInputTokens](../models/triggerinputtokens.mdx) | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 100000
} | -| `type` | *"compact_20260112"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `instructions` | *string* | ➖ | N/A | | +| `pauseAfterCompaction` | *boolean* | ➖ | N/A | | +| `trigger` | [models.TriggerInputTokens](../models/triggerinputtokens.mdx) | ➖ | N/A | \{
"type": "input_tokens",
"value": 100000
} | +| `type` | *"compact_20260112"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/embeddings.mdx b/docs/models/embeddings.mdx index 5e280dd48..ada537348 100644 --- a/docs/models/embeddings.mdx +++ b/docs/models/embeddings.mdx @@ -28,6 +28,6 @@ let value: Embeddings = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `requestCount` | *number* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `requestCount` | *number* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/endpointinfo.mdx b/docs/models/endpointinfo.mdx index a57a1f803..f5ebd9ce4 100644 --- a/docs/models/endpointinfo.mdx +++ b/docs/models/endpointinfo.mdx @@ -18,6 +18,6 @@ let value: EndpointInfo = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | -| `provider` | *string* | :heavy_check_mark: | N/A | -| `selected` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| `model` | *string* | ✅ | N/A | +| `provider` | *string* | ✅ | N/A | +| `selected` | *boolean* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/endpointsmetadata.mdx b/docs/models/endpointsmetadata.mdx index e892e58d4..1d15cdce5 100644 --- a/docs/models/endpointsmetadata.mdx +++ b/docs/models/endpointsmetadata.mdx @@ -23,5 +23,5 @@ let value: EndpointsMetadata = { | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `available` | [models.EndpointInfo](../models/endpointinfo.mdx)[] | :heavy_check_mark: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `available` | [models.EndpointInfo](../models/endpointinfo.mdx)[] | ✅ | N/A | +| `total` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/enduser.mdx b/docs/models/enduser.mdx index ed275b828..ce7f63d5c 100644 --- a/docs/models/enduser.mdx +++ b/docs/models/enduser.mdx @@ -19,7 +19,7 @@ let value: EndUser = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Registration creation time. | 2026-09-16T12:00:00Z | -| `isActive` | *boolean* | :heavy_check_mark: | Whether this registration is active. Not an inference authorization decision. | true | -| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | -| `user` | *string* | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | Registration creation time. | 2026-09-16T12:00:00Z | +| `isActive` | *boolean* | ✅ | Whether this registration is active. Not an inference authorization decision. | true | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | Last registration lifecycle update time. | 2026-09-16T12:00:00Z | +| `user` | *string* | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file diff --git a/docs/models/enduserresponse.mdx b/docs/models/enduserresponse.mdx index f21c4ccc9..ccf67e199 100644 --- a/docs/models/enduserresponse.mdx +++ b/docs/models/enduserresponse.mdx @@ -21,4 +21,4 @@ let value: EndUserResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.EndUser](../models/enduser.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
} | \ No newline at end of file +| `data` | [models.EndUser](../models/enduser.mdx) | ✅ | N/A | \{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
} | \ No newline at end of file diff --git a/docs/models/enumcapability.mdx b/docs/models/enumcapability.mdx index cf97cdb3d..717dc9259 100644 --- a/docs/models/enumcapability.mdx +++ b/docs/models/enumcapability.mdx @@ -23,5 +23,5 @@ let value: EnumCapability = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"enum"* | :heavy_check_mark: | N/A | -| `values` | *string*[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"enum"* | ✅ | N/A | +| `values` | *string*[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/errorevent.mdx b/docs/models/errorevent.mdx index 9f2858756..87877779a 100644 --- a/docs/models/errorevent.mdx +++ b/docs/models/errorevent.mdx @@ -22,8 +22,8 @@ let value: ErrorEvent = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *string* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `param` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"error"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *string* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `param` | *string* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"error"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/errors/badgatewayresponseerror.mdx b/docs/models/errors/badgatewayresponseerror.mdx index e784eea81..b4252d5a5 100644 --- a/docs/models/errors/badgatewayresponseerror.mdx +++ b/docs/models/errors/badgatewayresponseerror.mdx @@ -16,6 +16,6 @@ import { BadGatewayResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `error` | [models.BadGatewayResponseErrorData](../../models/badgatewayresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.BadGatewayResponseErrorData](../../models/badgatewayresponseerrordata.mdx) | ✅ | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/badrequestresponseerror.mdx b/docs/models/errors/badrequestresponseerror.mdx index 7bf21fec7..dfae28c77 100644 --- a/docs/models/errors/badrequestresponseerror.mdx +++ b/docs/models/errors/badrequestresponseerror.mdx @@ -16,6 +16,6 @@ import { BadRequestResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `error` | [models.BadRequestResponseErrorData](../../models/badrequestresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.BadRequestResponseErrorData](../../models/badrequestresponseerrordata.mdx) | ✅ | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/batcherrorresponse.mdx b/docs/models/errors/batcherrorresponse.mdx index 76992444d..75448e09c 100644 --- a/docs/models/errors/batcherrorresponse.mdx +++ b/docs/models/errors/batcherrorresponse.mdx @@ -14,4 +14,4 @@ import { BatchErrorResponse } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `error` | [models.BatchErrorResponseError](../../models/batcherrorresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | [models.BatchErrorResponseError](../../models/batcherrorresponseerror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/errors/batchpaymentrequiredresponseerror.mdx b/docs/models/errors/batchpaymentrequiredresponseerror.mdx index 6b20230a4..102b58ac9 100644 --- a/docs/models/errors/batchpaymentrequiredresponseerror.mdx +++ b/docs/models/errors/batchpaymentrequiredresponseerror.mdx @@ -16,15 +16,15 @@ import { BatchPaymentRequiredResponseError } from "@openrouter/sdk/models/errors | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `completionWindow` | [models.BatchPaymentRequiredResponseCompletionWindow](../../models/batchpaymentrequiredresponsecompletionwindow.mdx) | :heavy_check_mark: | N/A | -| `createdAt` | *number* | :heavy_check_mark: | N/A | -| `endpoint` | *string* | :heavy_check_mark: | N/A | -| `error` | [models.BatchPaymentRequiredResponseError](../../models/batchpaymentrequiredresponseerror.mdx) | :heavy_check_mark: | N/A | -| `finalizedAt` | *number* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.BatchPaymentRequiredResponseObject](../../models/batchpaymentrequiredresponseobject.mdx) | :heavy_check_mark: | N/A | -| `requestCounts` | [models.BatchPaymentRequiredResponseRequestCounts](../../models/batchpaymentrequiredresponserequestcounts.mdx) | :heavy_check_mark: | N/A | -| `results` | *any* | :heavy_check_mark: | Always null: results are withheld until the batch charge is covered. | -| `status` | [models.BatchPaymentRequiredResponseStatus](../../models/batchpaymentrequiredresponsestatus.mdx) | :heavy_check_mark: | N/A | -| `usage` | [models.BatchPaymentRequiredResponseUsage](../../models/batchpaymentrequiredresponseusage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `completionWindow` | [models.BatchPaymentRequiredResponseCompletionWindow](../../models/batchpaymentrequiredresponsecompletionwindow.mdx) | ✅ | N/A | +| `createdAt` | *number* | ✅ | N/A | +| `endpoint` | *string* | ✅ | N/A | +| `error` | [models.BatchPaymentRequiredResponseError](../../models/batchpaymentrequiredresponseerror.mdx) | ✅ | N/A | +| `finalizedAt` | *number* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `model` | *string* | ✅ | N/A | +| `object` | [models.BatchPaymentRequiredResponseObject](../../models/batchpaymentrequiredresponseobject.mdx) | ✅ | N/A | +| `requestCounts` | [models.BatchPaymentRequiredResponseRequestCounts](../../models/batchpaymentrequiredresponserequestcounts.mdx) | ✅ | N/A | +| `results` | *any* | ✅ | Always null: results are withheld until the batch charge is covered. | +| `status` | [models.BatchPaymentRequiredResponseStatus](../../models/batchpaymentrequiredresponsestatus.mdx) | ✅ | N/A | +| `usage` | [models.BatchPaymentRequiredResponseUsage](../../models/batchpaymentrequiredresponseusage.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/errors/conflictresponseerror.mdx b/docs/models/errors/conflictresponseerror.mdx index 7bbe26524..b673eb517 100644 --- a/docs/models/errors/conflictresponseerror.mdx +++ b/docs/models/errors/conflictresponseerror.mdx @@ -16,6 +16,6 @@ import { ConflictResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `error` | [models.ConflictResponseErrorData](../../models/conflictresponseerrordata.mdx) | :heavy_check_mark: | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.ConflictResponseErrorData](../../models/conflictresponseerrordata.mdx) | ✅ | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/createprivateendpointvalidationfailedresponseerror.mdx b/docs/models/errors/createprivateendpointvalidationfailedresponseerror.mdx index 501547393..e87437b6c 100644 --- a/docs/models/errors/createprivateendpointvalidationfailedresponseerror.mdx +++ b/docs/models/errors/createprivateendpointvalidationfailedresponseerror.mdx @@ -14,5 +14,5 @@ import { CreatePrivateEndpointValidationFailedResponseError } from "@openrouter/ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.CreatePrivateEndpointValidationFailedResponseData](../../models/createprivateendpointvalidationfailedresponsedata.mdx) | :heavy_check_mark: | N/A | -| `error` | [models.CreatePrivateEndpointValidationFailedResponseError](../../models/createprivateendpointvalidationfailedresponseerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.CreatePrivateEndpointValidationFailedResponseData](../../models/createprivateendpointvalidationfailedresponsedata.mdx) | ✅ | N/A | +| `error` | [models.CreatePrivateEndpointValidationFailedResponseError](../../models/createprivateendpointvalidationfailedresponseerror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/errors/edgenetworktimeoutresponseerror.mdx b/docs/models/errors/edgenetworktimeoutresponseerror.mdx index 4f43be5ac..0971540f9 100644 --- a/docs/models/errors/edgenetworktimeoutresponseerror.mdx +++ b/docs/models/errors/edgenetworktimeoutresponseerror.mdx @@ -16,6 +16,6 @@ import { EdgeNetworkTimeoutResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.EdgeNetworkTimeoutResponseErrorData](../../models/edgenetworktimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.EdgeNetworkTimeoutResponseErrorData](../../models/edgenetworktimeoutresponseerrordata.mdx) | ✅ | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/forbiddenresponseerror.mdx b/docs/models/errors/forbiddenresponseerror.mdx index 12da58092..98af9a2b1 100644 --- a/docs/models/errors/forbiddenresponseerror.mdx +++ b/docs/models/errors/forbiddenresponseerror.mdx @@ -16,6 +16,6 @@ import { ForbiddenResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `error` | [models.ForbiddenResponseErrorData](../../models/forbiddenresponseerrordata.mdx) | :heavy_check_mark: | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.ForbiddenResponseErrorData](../../models/forbiddenresponseerrordata.mdx) | ✅ | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/gatewaytimeoutresponseerror.mdx b/docs/models/errors/gatewaytimeoutresponseerror.mdx index b618a00de..991d54aee 100644 --- a/docs/models/errors/gatewaytimeoutresponseerror.mdx +++ b/docs/models/errors/gatewaytimeoutresponseerror.mdx @@ -16,6 +16,6 @@ import { GatewayTimeoutResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `error` | [models.GatewayTimeoutResponseErrorData](../../models/gatewaytimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.GatewayTimeoutResponseErrorData](../../models/gatewaytimeoutresponseerrordata.mdx) | ✅ | Error data for GatewayTimeoutResponse | \{
"code": 504,
"message": "The operation was aborted due to timeout"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/goneresponseerror.mdx b/docs/models/errors/goneresponseerror.mdx index 9623e61e7..4b11231e3 100644 --- a/docs/models/errors/goneresponseerror.mdx +++ b/docs/models/errors/goneresponseerror.mdx @@ -16,6 +16,6 @@ import { GoneResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | [models.GoneResponseErrorData](../../models/goneresponseerrordata.mdx) | :heavy_check_mark: | Error data for GoneResponse | \{
"code": 410,
"message": "The Coinbase APIs used by this endpoint have been deprecated, so the Coinbase Commerce credits API has been removed. Use the web credits purchase flow instead."
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.GoneResponseErrorData](../../models/goneresponseerrordata.mdx) | ✅ | Error data for GoneResponse | \{
"code": 410,
"message": "The Coinbase APIs used by this endpoint have been deprecated, so the Coinbase Commerce credits API has been removed. Use the web credits purchase flow instead."
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/internalserverresponseerror.mdx b/docs/models/errors/internalserverresponseerror.mdx index b3d9a23cd..3aa717468 100644 --- a/docs/models/errors/internalserverresponseerror.mdx +++ b/docs/models/errors/internalserverresponseerror.mdx @@ -16,6 +16,6 @@ import { InternalServerResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `error` | [models.InternalServerResponseErrorData](../../models/internalserverresponseerrordata.mdx) | :heavy_check_mark: | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.InternalServerResponseErrorData](../../models/internalserverresponseerrordata.mdx) | ✅ | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/internchaterrorresponse.mdx b/docs/models/errors/internchaterrorresponse.mdx index 97e17714b..e42609edd 100644 --- a/docs/models/errors/internchaterrorresponse.mdx +++ b/docs/models/errors/internchaterrorresponse.mdx @@ -16,4 +16,4 @@ import { InternChatErrorResponse } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | [models.InternChatError](../../models/internchaterror.mdx) | :heavy_check_mark: | The OpenAI-compatible error object. `metadata` is present on refusals from the chat route. Authentication refusals (`401`), the departed-creator `403` and the programme `404` carry only `code` and `message`. | \{
"code": 409,
"message": "That question is no longer waiting for an answer.",
"metadata": \{
"reason": "interaction_not_pending",
"retryable": false
}
} | \ No newline at end of file +| `error` | [models.InternChatError](../../models/internchaterror.mdx) | ✅ | The OpenAI-compatible error object. `metadata` is present on refusals from the chat route. Authentication refusals (`401`), the departed-creator `403` and the programme `404` carry only `code` and `message`. | \{
"code": 409,
"message": "That question is no longer waiting for an answer.",
"metadata": \{
"reason": "interaction_not_pending",
"retryable": false
}
} | \ No newline at end of file diff --git a/docs/models/errors/internlifecycleerror.mdx b/docs/models/errors/internlifecycleerror.mdx index 2c8afff63..0a4308663 100644 --- a/docs/models/errors/internlifecycleerror.mdx +++ b/docs/models/errors/internlifecycleerror.mdx @@ -16,4 +16,4 @@ import { InternLifecycleError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `error` | [models.InternLifecycleErrorError](../../models/internlifecycleerrorerror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | [models.InternLifecycleErrorError](../../models/internlifecycleerrorerror.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/errors/notfoundresponseerror.mdx b/docs/models/errors/notfoundresponseerror.mdx index 7bb92d48e..3f7c1c584 100644 --- a/docs/models/errors/notfoundresponseerror.mdx +++ b/docs/models/errors/notfoundresponseerror.mdx @@ -16,6 +16,6 @@ import { NotFoundResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `error` | [models.NotFoundResponseErrorData](../../models/notfoundresponseerrordata.mdx) | :heavy_check_mark: | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.NotFoundResponseErrorData](../../models/notfoundresponseerrordata.mdx) | ✅ | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/oautherrorresponse.mdx b/docs/models/errors/oautherrorresponse.mdx index 3d12a828f..6863dcb8e 100644 --- a/docs/models/errors/oautherrorresponse.mdx +++ b/docs/models/errors/oautherrorresponse.mdx @@ -16,5 +16,5 @@ import { OAuthErrorResponse } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `error` | [models.ErrorEnum](../../models/errorenum.mdx) | :heavy_check_mark: | N/A | -| `errorDescription` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | [models.ErrorEnum](../../models/errorenum.mdx) | ✅ | N/A | +| `errorDescription` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/errors/payloadtoolargeresponseerror.mdx b/docs/models/errors/payloadtoolargeresponseerror.mdx index 1372539eb..a5c9e8448 100644 --- a/docs/models/errors/payloadtoolargeresponseerror.mdx +++ b/docs/models/errors/payloadtoolargeresponseerror.mdx @@ -16,6 +16,6 @@ import { PayloadTooLargeResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `error` | [models.PayloadTooLargeResponseErrorData](../../models/payloadtoolargeresponseerrordata.mdx) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.PayloadTooLargeResponseErrorData](../../models/payloadtoolargeresponseerrordata.mdx) | ✅ | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/paymentrequiredresponseerror.mdx b/docs/models/errors/paymentrequiredresponseerror.mdx index 0bb8961d4..481b9d9db 100644 --- a/docs/models/errors/paymentrequiredresponseerror.mdx +++ b/docs/models/errors/paymentrequiredresponseerror.mdx @@ -16,6 +16,6 @@ import { PaymentRequiredResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `error` | [models.PaymentRequiredResponseErrorData](../../models/paymentrequiredresponseerrordata.mdx) | :heavy_check_mark: | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.PaymentRequiredResponseErrorData](../../models/paymentrequiredresponseerrordata.mdx) | ✅ | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/provideroverloadedresponseerror.mdx b/docs/models/errors/provideroverloadedresponseerror.mdx index a6a996fe3..df9f39708 100644 --- a/docs/models/errors/provideroverloadedresponseerror.mdx +++ b/docs/models/errors/provideroverloadedresponseerror.mdx @@ -16,6 +16,6 @@ import { ProviderOverloadedResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.ProviderOverloadedResponseErrorData](../../models/provideroverloadedresponseerrordata.mdx) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.ProviderOverloadedResponseErrorData](../../models/provideroverloadedresponseerrordata.mdx) | ✅ | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/requesttimeoutresponseerror.mdx b/docs/models/errors/requesttimeoutresponseerror.mdx index 4e36c370a..2227deda4 100644 --- a/docs/models/errors/requesttimeoutresponseerror.mdx +++ b/docs/models/errors/requesttimeoutresponseerror.mdx @@ -16,6 +16,6 @@ import { RequestTimeoutResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `error` | [models.RequestTimeoutResponseErrorData](../../models/requesttimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.RequestTimeoutResponseErrorData](../../models/requesttimeoutresponseerrordata.mdx) | ✅ | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/serviceunavailableresponseerror.mdx b/docs/models/errors/serviceunavailableresponseerror.mdx index 79961f7c1..994daddcb 100644 --- a/docs/models/errors/serviceunavailableresponseerror.mdx +++ b/docs/models/errors/serviceunavailableresponseerror.mdx @@ -16,6 +16,6 @@ import { ServiceUnavailableResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `error` | [models.ServiceUnavailableResponseErrorData](../../models/serviceunavailableresponseerrordata.mdx) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.ServiceUnavailableResponseErrorData](../../models/serviceunavailableresponseerrordata.mdx) | ✅ | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/toomanyrequestsresponseerror.mdx b/docs/models/errors/toomanyrequestsresponseerror.mdx index a25646e87..933f9cd0b 100644 --- a/docs/models/errors/toomanyrequestsresponseerror.mdx +++ b/docs/models/errors/toomanyrequestsresponseerror.mdx @@ -16,6 +16,6 @@ import { TooManyRequestsResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `error` | [models.TooManyRequestsResponseErrorData](../../models/toomanyrequestsresponseerrordata.mdx) | :heavy_check_mark: | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.TooManyRequestsResponseErrorData](../../models/toomanyrequestsresponseerrordata.mdx) | ✅ | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/unauthorizedresponseerror.mdx b/docs/models/errors/unauthorizedresponseerror.mdx index 6d4c4de60..c27b6ad9c 100644 --- a/docs/models/errors/unauthorizedresponseerror.mdx +++ b/docs/models/errors/unauthorizedresponseerror.mdx @@ -16,6 +16,6 @@ import { UnauthorizedResponseError } from "@openrouter/sdk/models/errors"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `error` | [models.UnauthorizedResponseErrorData](../../models/unauthorizedresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.UnauthorizedResponseErrorData](../../models/unauthorizedresponseerrordata.mdx) | ✅ | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/errors/unprocessableentityresponseerror.mdx b/docs/models/errors/unprocessableentityresponseerror.mdx index f7d1764b9..e220b1dac 100644 --- a/docs/models/errors/unprocessableentityresponseerror.mdx +++ b/docs/models/errors/unprocessableentityresponseerror.mdx @@ -16,6 +16,6 @@ import { UnprocessableEntityResponseError } from "@openrouter/sdk/models/errors" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `error` | [models.UnprocessableEntityResponseErrorData](../../models/unprocessableentityresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | -| `openrouterMetadata` | Record\ | :heavy_minus_sign: | N/A | | -| `userId` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `error` | [models.UnprocessableEntityResponseErrorData](../../models/unprocessableentityresponseerrordata.mdx) | ✅ | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | +| `openrouterMetadata` | Record\ | ➖ | N/A | | +| `userId` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/failedmodel.mdx b/docs/models/failedmodel.mdx index d409d02fa..62f6e8014 100644 --- a/docs/models/failedmodel.mdx +++ b/docs/models/failedmodel.mdx @@ -17,6 +17,6 @@ let value: FailedModel = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `error` | *string* | :heavy_check_mark: | Error message describing why the model failed. | -| `model` | *string* | :heavy_check_mark: | Slug of the analysis model that failed. | -| `statusCode` | *number* | :heavy_minus_sign: | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file +| `error` | *string* | ✅ | Error message describing why the model failed. | +| `model` | *string* | ✅ | Slug of the analysis model that failed. | +| `statusCode` | *number* | ➖ | HTTP status code from the upstream response, when available (e.g. 402, 429). | \ No newline at end of file diff --git a/docs/models/filecitation.mdx b/docs/models/filecitation.mdx index ea934a580..220452804 100644 --- a/docs/models/filecitation.mdx +++ b/docs/models/filecitation.mdx @@ -19,7 +19,7 @@ let value: FileCitation = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | -| `type` | *"file_citation"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileId` | *string* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `index` | *number* | ✅ | N/A | +| `type` | *"file_citation"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fileparserplugin.mdx b/docs/models/fileparserplugin.mdx index 50efc278a..03b77bc8d 100644 --- a/docs/models/fileparserplugin.mdx +++ b/docs/models/fileparserplugin.mdx @@ -16,6 +16,6 @@ let value: FileParserPlugin = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | | -| `id` | *"file-parser"* | :heavy_check_mark: | N/A | | -| `pdf` | [models.PDFParserOptions](../models/pdfparseroptions.mdx) | :heavy_minus_sign: | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file +| `enabled` | *boolean* | ➖ | Set to false to disable the file-parser plugin for this request. Defaults to true. | | +| `id` | *"file-parser"* | ✅ | N/A | | +| `pdf` | [models.PDFParserOptions](../models/pdfparseroptions.mdx) | ➖ | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file diff --git a/docs/models/filepath.mdx b/docs/models/filepath.mdx index 50f916732..b0aedccb2 100644 --- a/docs/models/filepath.mdx +++ b/docs/models/filepath.mdx @@ -18,6 +18,6 @@ let value: FilePath = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | -| `type` | *"file_path"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileId` | *string* | ✅ | N/A | +| `index` | *number* | ✅ | N/A | +| `type` | *"file_path"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/filesearchservertool.mdx b/docs/models/filesearchservertool.mdx index 8406aaa62..0c040999a 100644 --- a/docs/models/filesearchservertool.mdx +++ b/docs/models/filesearchservertool.mdx @@ -21,8 +21,8 @@ let value: FileSearchServerTool = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `filters` | *models.FiltersUnion* | :heavy_minus_sign: | N/A | -| `maxNumResults` | *number* | :heavy_minus_sign: | N/A | -| `rankingOptions` | [models.RankingOptions](../models/rankingoptions.mdx) | :heavy_minus_sign: | N/A | -| `type` | [models.TypeFileSearch](../models/typefilesearch.mdx) | :heavy_check_mark: | N/A | -| `vectorStoreIds` | *string*[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filters` | *models.FiltersUnion* | ➖ | N/A | +| `maxNumResults` | *number* | ➖ | N/A | +| `rankingOptions` | [models.RankingOptions](../models/rankingoptions.mdx) | ➖ | N/A | +| `type` | [models.TypeFileSearch](../models/typefilesearch.mdx) | ✅ | N/A | +| `vectorStoreIds` | *string*[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/filesservertool.mdx b/docs/models/filesservertool.mdx index 2e5bbe877..ddb58e0f5 100644 --- a/docs/models/filesservertool.mdx +++ b/docs/models/filesservertool.mdx @@ -18,5 +18,5 @@ let value: FilesServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `parameters` | [models.FilesServerToolConfig](../models/filesservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:files server tool | \{} | -| `type` | [models.FilesServerToolType](../models/filesservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.FilesServerToolConfig](../models/filesservertoolconfig.mdx) | ➖ | Configuration for the openrouter:files server tool | \{} | +| `type` | [models.FilesServerToolType](../models/filesservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/filters.mdx b/docs/models/filters.mdx index ded802ad8..577e8b5db 100644 --- a/docs/models/filters.mdx +++ b/docs/models/filters.mdx @@ -18,6 +18,6 @@ let value: Filters = { | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `key` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.FiltersType](../models/filterstype.mdx) | :heavy_check_mark: | N/A | -| `value` | *models.FileSearchServerToolValue2* | :heavy_check_mark: | N/A | \ No newline at end of file +| `key` | *string* | ✅ | N/A | +| `type` | [models.FiltersType](../models/filterstype.mdx) | ✅ | N/A | +| `value` | *models.FileSearchServerToolValue2* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/forbiddenresponseerrordata.mdx b/docs/models/forbiddenresponseerrordata.mdx index d788015f2..4b465ed54 100644 --- a/docs/models/forbiddenresponseerrordata.mdx +++ b/docs/models/forbiddenresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: ForbiddenResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/formatgrammar.mdx b/docs/models/formatgrammar.mdx index 08592971b..e19efd23e 100644 --- a/docs/models/formatgrammar.mdx +++ b/docs/models/formatgrammar.mdx @@ -18,6 +18,6 @@ let value: FormatGrammar = { | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `definition` | *string* | :heavy_check_mark: | N/A | -| `syntax` | [models.Syntax](../models/syntax.mdx) | :heavy_check_mark: | N/A | -| `type` | *"grammar"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `definition` | *string* | ✅ | N/A | +| `syntax` | [models.Syntax](../models/syntax.mdx) | ✅ | N/A | +| `type` | *"grammar"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/formatjsonobjectconfig.mdx b/docs/models/formatjsonobjectconfig.mdx index 2ca24f719..b0029ec26 100644 --- a/docs/models/formatjsonobjectconfig.mdx +++ b/docs/models/formatjsonobjectconfig.mdx @@ -18,4 +18,4 @@ let value: FormatJsonObjectConfig = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"json_object"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"json_object"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/formatjsonschemaconfig.mdx b/docs/models/formatjsonschemaconfig.mdx index 54e482d99..eae9f1df0 100644 --- a/docs/models/formatjsonschemaconfig.mdx +++ b/docs/models/formatjsonschemaconfig.mdx @@ -22,8 +22,8 @@ let value: FormatJsonSchemaConfig = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `schema` | Record\ | :heavy_check_mark: | N/A | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | -| `type` | *"json_schema"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `description` | *string* | ➖ | N/A | +| `name` | *string* | ✅ | N/A | +| `schema` | Record\ | ✅ | N/A | +| `strict` | *boolean* | ➖ | N/A | +| `type` | *"json_schema"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/formattext.mdx b/docs/models/formattext.mdx index d5d7ce3c9..645685121 100644 --- a/docs/models/formattext.mdx +++ b/docs/models/formattext.mdx @@ -16,4 +16,4 @@ let value: FormatText = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"text"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/formattextconfig.mdx b/docs/models/formattextconfig.mdx index 5c386500a..70c53eb7a 100644 --- a/docs/models/formattextconfig.mdx +++ b/docs/models/formattextconfig.mdx @@ -18,4 +18,4 @@ let value: FormatTextConfig = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"text"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/frameimage.mdx b/docs/models/frameimage.mdx index 8a85c56fc..33ee001b3 100644 --- a/docs/models/frameimage.mdx +++ b/docs/models/frameimage.mdx @@ -20,6 +20,6 @@ let value: FrameImage = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `imageUrl` | [models.FrameImageImageUrl](../models/frameimageimageurl.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.FrameImageType](../models/frameimagetype.mdx) | :heavy_check_mark: | N/A | | -| `frameType` | [models.FrameType](../models/frametype.mdx) | :heavy_check_mark: | Whether this image represents the first or last frame of the video | first_frame | \ No newline at end of file +| `imageUrl` | [models.FrameImageImageUrl](../models/frameimageimageurl.mdx) | ✅ | N/A | | +| `type` | [models.FrameImageType](../models/frameimagetype.mdx) | ✅ | N/A | | +| `frameType` | [models.FrameType](../models/frametype.mdx) | ✅ | Whether this image represents the first or last frame of the video | first_frame | \ No newline at end of file diff --git a/docs/models/frameimageimageurl.mdx b/docs/models/frameimageimageurl.mdx index 87986ade8..2ae8c051d 100644 --- a/docs/models/frameimageimageurl.mdx +++ b/docs/models/frameimageimageurl.mdx @@ -16,4 +16,4 @@ let value: FrameImageImageUrl = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/freemodeldailyrequests.mdx b/docs/models/freemodeldailyrequests.mdx index ba3a2a078..68089b68a 100644 --- a/docs/models/freemodeldailyrequests.mdx +++ b/docs/models/freemodeldailyrequests.mdx @@ -20,6 +20,6 @@ let value: FreeModelDailyRequests = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `limit` | *number* | :heavy_check_mark: | Free-model requests the account may make per UTC day; the ceiling depends on total credits purchased and is independent of `is_free_tier` | 50 | -| `remaining` | *number* | :heavy_check_mark: | Free-model requests left in the current UTC day | 38 | -| `used` | *number* | :heavy_check_mark: | Free-model requests recorded for the account so far in the current UTC day | 12 | \ No newline at end of file +| `limit` | *number* | ✅ | Free-model requests the account may make per UTC day; the ceiling depends on total credits purchased and is independent of `is_free_tier` | 50 | +| `remaining` | *number* | ✅ | Free-model requests left in the current UTC day | 38 | +| `used` | *number* | ✅ | Free-model requests recorded for the account so far in the current UTC day | 12 | \ No newline at end of file diff --git a/docs/models/functioncallargsdeltaevent.mdx b/docs/models/functioncallargsdeltaevent.mdx index 7c87b07c3..e3cf40707 100644 --- a/docs/models/functioncallargsdeltaevent.mdx +++ b/docs/models/functioncallargsdeltaevent.mdx @@ -22,8 +22,8 @@ let value: FunctionCallArgsDeltaEvent = { | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.function_call_arguments.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.function_call_arguments.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/functioncallargsdoneevent.mdx b/docs/models/functioncallargsdoneevent.mdx index 62f562c22..95a76270a 100644 --- a/docs/models/functioncallargsdoneevent.mdx +++ b/docs/models/functioncallargsdoneevent.mdx @@ -23,9 +23,9 @@ let value: FunctionCallArgsDoneEvent = { | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.function_call_arguments.done"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `name` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.function_call_arguments.done"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/functioncallitem.mdx b/docs/models/functioncallitem.mdx index 2428bdf8f..54801ee78 100644 --- a/docs/models/functioncallitem.mdx +++ b/docs/models/functioncallitem.mdx @@ -21,13 +21,13 @@ let value: FunctionCallItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `async` | *boolean* | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `subagentId` | *string* | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | -| `subagentItems` | [models.FunctionCallItemSubagentItem](../models/functioncallitemsubagentitem.mdx)[] | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | -| `type` | [models.FunctionCallItemType](../models/functioncallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | | +| `async` | *boolean* | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `namespace` | *string* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ➖ | N/A | completed | +| `subagentId` | *string* | ➖ | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | +| `subagentItems` | [models.FunctionCallItemSubagentItem](../models/functioncallitemsubagentitem.mdx)[] | ➖ | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | +| `type` | [models.FunctionCallItemType](../models/functioncallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/functioncallitemsubagentitem.mdx b/docs/models/functioncallitemsubagentitem.mdx index a83f465e9..ed7a34864 100644 --- a/docs/models/functioncallitemsubagentitem.mdx +++ b/docs/models/functioncallitemsubagentitem.mdx @@ -16,5 +16,5 @@ let value: FunctionCallItemSubagentItem = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *string* | ✅ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/functioncalloutputitem.mdx b/docs/models/functioncalloutputitem.mdx index 9e2466e4a..1afb6ee39 100644 --- a/docs/models/functioncalloutputitem.mdx +++ b/docs/models/functioncalloutputitem.mdx @@ -20,8 +20,8 @@ let value: FunctionCallOutputItem = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `output` | *models.FunctionCallOutputItemOutputUnion2* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.FunctionCallOutputItemTypeFunctionCallOutput](../models/functioncalloutputitemtypefunctioncalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `output` | *models.FunctionCallOutputItemOutputUnion2* | ✅ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [models.FunctionCallOutputItemTypeFunctionCallOutput](../models/functioncalloutputitemtypefunctioncalloutput.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/functioncalloutputitemoutputinputimage.mdx b/docs/models/functioncalloutputitemoutputinputimage.mdx index 209d171cf..917336d09 100644 --- a/docs/models/functioncalloutputitemoutputinputimage.mdx +++ b/docs/models/functioncalloutputitemoutputinputimage.mdx @@ -19,7 +19,7 @@ let value: FunctionCallOutputItemOutputInputImage = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `detail` | [models.FunctionCallOutputItemDetail](../models/functioncalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [models.FunctionCallOutputItemDetail](../models/functioncalloutputitemdetail.mdx) | ✅ | N/A | +| `fileId` | *string* | ➖ | N/A | +| `imageUrl` | *string* | ➖ | N/A | +| `type` | *"input_image"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusionanalysisresult.mdx b/docs/models/fusionanalysisresult.mdx index 04acea1be..33c295277 100644 --- a/docs/models/fusionanalysisresult.mdx +++ b/docs/models/fusionanalysisresult.mdx @@ -53,8 +53,8 @@ let value: FusionAnalysisResult = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `blindSpots` | *string*[] | :heavy_check_mark: | N/A | -| `consensus` | *string*[] | :heavy_check_mark: | N/A | -| `contradictions` | [models.Contradiction](../models/contradiction.mdx)[] | :heavy_check_mark: | N/A | -| `partialCoverage` | [models.PartialCoverage](../models/partialcoverage.mdx)[] | :heavy_check_mark: | N/A | -| `uniqueInsights` | [models.UniqueInsight](../models/uniqueinsight.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `blindSpots` | *string*[] | ✅ | N/A | +| `consensus` | *string*[] | ✅ | N/A | +| `contradictions` | [models.Contradiction](../models/contradiction.mdx)[] | ✅ | N/A | +| `partialCoverage` | [models.PartialCoverage](../models/partialcoverage.mdx)[] | ✅ | N/A | +| `uniqueInsights` | [models.UniqueInsight](../models/uniqueinsight.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusioncallanalysiscompletedevent.mdx b/docs/models/fusioncallanalysiscompletedevent.mdx index c70ea1e85..30acd90cb 100644 --- a/docs/models/fusioncallanalysiscompletedevent.mdx +++ b/docs/models/fusioncallanalysiscompletedevent.mdx @@ -59,8 +59,8 @@ let value: FusionCallAnalysisCompletedEvent = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis` | [models.FusionAnalysisResult](../models/fusionanalysisresult.mdx) | :heavy_check_mark: | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | -| `itemId` | *string* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.fusion_call.analysis.completed"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `analysis` | [models.FusionAnalysisResult](../models/fusionanalysisresult.mdx) | ✅ | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | +| `itemId` | *string* | ✅ | N/A | | +| `outputIndex` | *number* | ✅ | N/A | | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `type` | *"response.fusion_call.analysis.completed"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/fusioncallanalysisinprogressevent.mdx b/docs/models/fusioncallanalysisinprogressevent.mdx index b5afb6706..3678fd575 100644 --- a/docs/models/fusioncallanalysisinprogressevent.mdx +++ b/docs/models/fusioncallanalysisinprogressevent.mdx @@ -23,9 +23,9 @@ let value: FusionCallAnalysisInProgressEvent = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analystModel` | *string* | :heavy_check_mark: | Slug of the model producing the structured analysis. | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| ~~`judgeModel`~~ | *string* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated alias of `analyst_model`, kept so existing consumers keep working. Always carries the same value. Use `analyst_model`. | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.fusion_call.analysis.in_progress"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `analystModel` | *string* | ✅ | Slug of the model producing the structured analysis. | +| `itemId` | *string* | ✅ | N/A | +| ~~`judgeModel`~~ | *string* | ✅ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated alias of `analyst_model`, kept so existing consumers keep working. Always carries the same value. Use `analyst_model`. | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.fusion_call.analysis.in_progress"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusioncallcompletedevent.mdx b/docs/models/fusioncallcompletedevent.mdx index 0a897eb69..edfd9776a 100644 --- a/docs/models/fusioncallcompletedevent.mdx +++ b/docs/models/fusioncallcompletedevent.mdx @@ -21,7 +21,7 @@ let value: FusionCallCompletedEvent = { | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.fusion_call.completed"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.fusion_call.completed"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusioncallinprogressevent.mdx b/docs/models/fusioncallinprogressevent.mdx index 7989c933a..9697c1d95 100644 --- a/docs/models/fusioncallinprogressevent.mdx +++ b/docs/models/fusioncallinprogressevent.mdx @@ -21,7 +21,7 @@ let value: FusionCallInProgressEvent = { | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.fusion_call.in_progress"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.fusion_call.in_progress"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusioncallpaneladdedevent.mdx b/docs/models/fusioncallpaneladdedevent.mdx index f55d09fd5..13c7396db 100644 --- a/docs/models/fusioncallpaneladdedevent.mdx +++ b/docs/models/fusioncallpaneladdedevent.mdx @@ -22,8 +22,8 @@ let value: FusionCallPanelAddedEvent = { | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.fusion_call.panel.added"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `model` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.fusion_call.panel.added"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusioncallpanelcompletedevent.mdx b/docs/models/fusioncallpanelcompletedevent.mdx index 86cea5f2d..40414afa7 100644 --- a/docs/models/fusioncallpanelcompletedevent.mdx +++ b/docs/models/fusioncallpanelcompletedevent.mdx @@ -23,9 +23,9 @@ let value: FusionCallPanelCompletedEvent = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `content` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.fusion_call.panel.completed"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `model` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.fusion_call.panel.completed"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusioncallpaneldeltaevent.mdx b/docs/models/fusioncallpaneldeltaevent.mdx index b9571432e..0a77884fe 100644 --- a/docs/models/fusioncallpaneldeltaevent.mdx +++ b/docs/models/fusioncallpaneldeltaevent.mdx @@ -23,9 +23,9 @@ let value: FusionCallPanelDeltaEvent = { | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.fusion_call.panel.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `model` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.fusion_call.panel.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusioncallpanelfailedevent.mdx b/docs/models/fusioncallpanelfailedevent.mdx index ff8aa1bd6..27503ffad 100644 --- a/docs/models/fusioncallpanelfailedevent.mdx +++ b/docs/models/fusioncallpanelfailedevent.mdx @@ -23,10 +23,10 @@ let value: FusionCallPanelFailedEvent = { | Field | Type | Required | Description | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `error` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `statusCode` | *number* | :heavy_minus_sign: | N/A | -| `type` | *"response.fusion_call.panel.failed"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `model` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `statusCode` | *number* | ➖ | N/A | +| `type` | *"response.fusion_call.panel.failed"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusioncallpanelreasoningdeltaevent.mdx b/docs/models/fusioncallpanelreasoningdeltaevent.mdx index dae53cd19..0612bd63e 100644 --- a/docs/models/fusioncallpanelreasoningdeltaevent.mdx +++ b/docs/models/fusioncallpanelreasoningdeltaevent.mdx @@ -23,9 +23,9 @@ let value: FusionCallPanelReasoningDeltaEvent = { | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.fusion_call.panel.reasoning.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `model` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.fusion_call.panel.reasoning.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/fusionplugin.mdx b/docs/models/fusionplugin.mdx index b65e03239..693943661 100644 --- a/docs/models/fusionplugin.mdx +++ b/docs/models/fusionplugin.mdx @@ -16,10 +16,10 @@ let value: FusionPlugin = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysisModels` | *string*[] | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, slugs of models to run in parallel as the "expert panel" the analyst analyzes. Each model receives the same user prompt with web_search + web_fetch enabled. Capped at 8 models to bound cost amplification. When omitted, defaults to the Quality preset from the /labs/fusion UI (~anthropic/claude-opus-latest, ~openai/gpt-sol-latest, ~google/gemini-pro-latest). | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable Fusion configuration for a run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. Defaults to true. | | -| `id` | *"fusion"* | :heavy_check_mark: | N/A | | -| `maxToolCalls` | *number* | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | -| `model` | *string* | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the slug of the model that performs both the analyst step (with web_search + web_fetch) and the final synthesis. When omitted, defaults to the first model in the Quality preset. | ~anthropic/claude-opus-latest | -| `preset` | [models.PresetEnum](../models/presetenum.mdx) | :heavy_minus_sign: | Configuration for a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. A curated OpenRouter preset (slugs follow `-`, e.g. `general-high`). Expands server-side into the preset's analysis_models panel and analyst model, so callers never name individual models. Explicitly provided `analysis_models` / `model` take precedence. | general-high | -| `tools` | [models.FusionPluginTool](../models/fusionplugintool.mdx)[] | :heavy_minus_sign: | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file +| `analysisModels` | *string*[] | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, slugs of models to run in parallel as the "expert panel" the analyst analyzes. Each model receives the same user prompt with web_search + web_fetch enabled. Capped at 8 models to bound cost amplification. When omitted, defaults to the Quality preset from the /labs/fusion UI (~anthropic/claude-opus-latest, ~openai/gpt-sol-latest, ~google/gemini-pro-latest). | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | +| `enabled` | *boolean* | ➖ | Set to false to disable Fusion configuration for a run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. Defaults to true. | | +| `id` | *"fusion"* | ✅ | N/A | | +| `maxToolCalls` | *number* | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | +| `model` | *string* | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, the slug of the model that performs both the analyst step (with web_search + web_fetch) and the final synthesis. When omitted, defaults to the first model in the Quality preset. | ~anthropic/claude-opus-latest | +| `preset` | [models.PresetEnum](../models/presetenum.mdx) | ➖ | Configuration for a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool. A curated OpenRouter preset (slugs follow `-`, e.g. `general-high`). Expands server-side into the preset's analysis_models panel and analyst model, so callers never name individual models. Explicitly provided `analysis_models` / `model` take precedence. | general-high | +| `tools` | [models.FusionPluginTool](../models/fusionplugintool.mdx)[] | ➖ | For a Fusion run started by the `openrouter/fusion` model slug or `openrouter:fusion` server tool, server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file diff --git a/docs/models/fusionplugintool.mdx b/docs/models/fusionplugintool.mdx index d8dbd42f8..166229951 100644 --- a/docs/models/fusionplugintool.mdx +++ b/docs/models/fusionplugintool.mdx @@ -16,5 +16,5 @@ let value: FusionPluginTool = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `parameters` | Record\ | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | -| `type` | *string* | :heavy_check_mark: | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `parameters` | Record\ | ➖ | Optional configuration forwarded as the tool's `parameters` object. | +| `type` | *string* | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file diff --git a/docs/models/fusionservertoolconfig.mdx b/docs/models/fusionservertoolconfig.mdx index ee31998d7..80d077c6d 100644 --- a/docs/models/fusionservertoolconfig.mdx +++ b/docs/models/fusionservertoolconfig.mdx @@ -16,11 +16,11 @@ let value: FusionServerToolConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `analysisModels` | *string*[] | :heavy_minus_sign: | Slugs of models to run in parallel as the analysis panel. Each model receives the user prompt with openrouter:web_search and openrouter:web_fetch enabled, then an analyst model summarizes the collective output into structured analysis JSON. Capped at 8 models to bound cost amplification. Defaults to the Quality preset from /labs/fusion. | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning tokens) each panelist and the analyst model may produce per inner call. Controls the total output budget so reasoning-heavy models like GPT-5.5 do not exhaust their token allowance before producing visible text. Defaults to 16000 when omitted. | 16384 | -| `maxToolCalls` | *number* | :heavy_minus_sign: | Maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | -| `model` | *string* | :heavy_minus_sign: | Slug of the analyst model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | -| `reasoning` | [models.FusionServerToolConfigReasoning](../models/fusionservertoolconfigreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to panelist and analyst inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. | | -| `temperature` | *number* | :heavy_minus_sign: | Temperature forwarded to panelist inner calls. The analyst always runs at temperature 0 regardless of this value. When omitted, the provider's default applies. | 0.7 | -| `tools` | [models.FusionServerToolConfigTool](../models/fusionservertoolconfigtool.mdx)[] | :heavy_minus_sign: | Server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file +| `analysisModels` | *string*[] | ➖ | Slugs of models to run in parallel as the analysis panel. Each model receives the user prompt with openrouter:web_search and openrouter:web_fetch enabled, then an analyst model summarizes the collective output into structured analysis JSON. Capped at 8 models to bound cost amplification. Defaults to the Quality preset from /labs/fusion. | [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
] | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `maxCompletionTokens` | *number* | ➖ | Maximum number of output tokens (including reasoning tokens) each panelist and the analyst model may produce per inner call. Controls the total output budget so reasoning-heavy models like GPT-5.5 do not exhaust their token allowance before producing visible text. Defaults to 16000 when omitted. | 16384 | +| `maxToolCalls` | *number* | ➖ | Maximum number of tool-calling steps each panelist (analysis model) and the analyst model may take during their agentic web-research loop. Models with web_search/web_fetch enabled iterate until they produce a text response or hit this ceiling. Defaults to 4. Capped at 16. | 12 | +| `model` | *string* | ➖ | Slug of the analyst model that produces the structured analysis JSON. Defaults to the model used in the outer API request. | ~anthropic/claude-opus-latest | +| `reasoning` | [models.FusionServerToolConfigReasoning](../models/fusionservertoolconfigreasoning.mdx) | ➖ | Reasoning configuration forwarded to panelist and analyst inner calls. Use this to control reasoning effort and token budget for models that support extended thinking. | | +| `temperature` | *number* | ➖ | Temperature forwarded to panelist inner calls. The analyst always runs at temperature 0 regardless of this value. When omitted, the provider's default applies. | 0.7 | +| `tools` | [models.FusionServerToolConfigTool](../models/fusionservertoolconfigtool.mdx)[] | ➖ | Server tools available to panelist and analyst inner calls. Each entry uses the same `{ type, parameters? }` shorthand as the outer Chat Completions request. When omitted, defaults to `[{ type: "openrouter:web_search" }, { type: "openrouter:web_fetch" }]`. Pass an empty array to disable tools entirely (panelists answer from parametric knowledge only). | [
\{
"parameters": \{
"excluded_domains": [
"example.com"
]
},
"type": "openrouter:web_search"
},
\{
"type": "openrouter:web_fetch"
}
] | \ No newline at end of file diff --git a/docs/models/fusionservertoolconfigreasoning.mdx b/docs/models/fusionservertoolconfigreasoning.mdx index d54a33f05..cadee6af6 100644 --- a/docs/models/fusionservertoolconfigreasoning.mdx +++ b/docs/models/fusionservertoolconfigreasoning.mdx @@ -16,5 +16,5 @@ let value: FusionServerToolConfigReasoning = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `effort` | [models.FusionServerToolConfigEffort](../models/fusionservertoolconfigeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for panelist and analyst inner calls. | -| `maxTokens` | *number* | :heavy_minus_sign: | Maximum number of reasoning tokens each panelist and analyst model may use. Helps bound cost when models allocate too much budget to chain-of-thought. | \ No newline at end of file +| `effort` | [models.FusionServerToolConfigEffort](../models/fusionservertoolconfigeffort.mdx) | ➖ | Reasoning effort level for panelist and analyst inner calls. | +| `maxTokens` | *number* | ➖ | Maximum number of reasoning tokens each panelist and analyst model may use. Helps bound cost when models allocate too much budget to chain-of-thought. | \ No newline at end of file diff --git a/docs/models/fusionservertoolconfigtool.mdx b/docs/models/fusionservertoolconfigtool.mdx index 482e236d5..c33af7c10 100644 --- a/docs/models/fusionservertoolconfigtool.mdx +++ b/docs/models/fusionservertoolconfigtool.mdx @@ -16,5 +16,5 @@ let value: FusionServerToolConfigTool = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `parameters` | Record\ | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | -| `type` | *string* | :heavy_check_mark: | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file +| `parameters` | Record\ | ➖ | Optional configuration forwarded as the tool's `parameters` object. | +| `type` | *string* | ✅ | Server tool type identifier (e.g. "openrouter:web_search", "openrouter:web_fetch"). | \ No newline at end of file diff --git a/docs/models/fusionservertoolopenrouter.mdx b/docs/models/fusionservertoolopenrouter.mdx index 3a2448c8b..a41e043b8 100644 --- a/docs/models/fusionservertoolopenrouter.mdx +++ b/docs/models/fusionservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: FusionServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `parameters` | [models.FusionServerToolConfig](../models/fusionservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
]
} | -| `type` | [models.FusionServerToolOpenRouterType](../models/fusionservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.FusionServerToolConfig](../models/fusionservertoolconfig.mdx) | ➖ | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-sol-latest",
"~google/gemini-pro-latest"
]
} | +| `type` | [models.FusionServerToolOpenRouterType](../models/fusionservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/fusionsource.mdx b/docs/models/fusionsource.mdx index 065707d84..d0f846e49 100644 --- a/docs/models/fusionsource.mdx +++ b/docs/models/fusionsource.mdx @@ -19,5 +19,5 @@ let value: FusionSource = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `title` | *string* | :heavy_check_mark: | Title of the retrieved web page. | -| `url` | *string* | :heavy_check_mark: | URL of the web page a panel or the analyst retrieved during the run. | \ No newline at end of file +| `title` | *string* | ✅ | Title of the retrieved web page. | +| `url` | *string* | ✅ | URL of the web page a panel or the analyst retrieved during the run. | \ No newline at end of file diff --git a/docs/models/gatewaytimeoutresponseerrordata.mdx b/docs/models/gatewaytimeoutresponseerrordata.mdx index f242ec691..25db773d8 100644 --- a/docs/models/gatewaytimeoutresponseerrordata.mdx +++ b/docs/models/gatewaytimeoutresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: GatewayTimeoutResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/generationcontentdata.mdx b/docs/models/generationcontentdata.mdx index 63eb62866..80a6a3070 100644 --- a/docs/models/generationcontentdata.mdx +++ b/docs/models/generationcontentdata.mdx @@ -30,6 +30,6 @@ let value: GenerationContentData = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `error` | [models.GenerationContentError](../models/generationcontenterror.mdx) | :heavy_check_mark: | The stored failure for this generation, or null when it succeeded | \{
"message": "Timed out waiting for the provider",
"previous_errors": [
\{
"code": 429,
"message": "Provider returned error",
"provider_name": "Google",
"raw": "\{\"error\":\{\"code\":429,\"message\":\"Resource exhausted\"}}"
}
],
"provider_name": "Vertex",
"raw": "\{\"error\":\{\"code\":504,\"message\":\"Deadline exceeded\"}}",
"status": 504
} | -| `input` | *models.InputUnion* | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | | -| `output` | [models.GenerationContentDataOutput](../models/generationcontentdataoutput.mdx) | :heavy_check_mark: | The output from the generation | | \ No newline at end of file +| `error` | [models.GenerationContentError](../models/generationcontenterror.mdx) | ✅ | The stored failure for this generation, or null when it succeeded | \{
"message": "Timed out waiting for the provider",
"previous_errors": [
\{
"code": 429,
"message": "Provider returned error",
"provider_name": "Google",
"raw": "\{\"error\":\{\"code\":429,\"message\":\"Resource exhausted\"}}"
}
],
"provider_name": "Vertex",
"raw": "\{\"error\":\{\"code\":504,\"message\":\"Deadline exceeded\"}}",
"status": 504
} | +| `input` | *models.InputUnion* | ✅ | The input to the generation — either a prompt string or an array of messages | | +| `output` | [models.GenerationContentDataOutput](../models/generationcontentdataoutput.mdx) | ✅ | The output from the generation | | \ No newline at end of file diff --git a/docs/models/generationcontentdataoutput.mdx b/docs/models/generationcontentdataoutput.mdx index d943c30d0..7f1779e2d 100644 --- a/docs/models/generationcontentdataoutput.mdx +++ b/docs/models/generationcontentdataoutput.mdx @@ -19,5 +19,5 @@ let value: GenerationContentDataOutput = { | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `completion` | *string* | :heavy_check_mark: | The completion output | The meaning of life is a philosophical question... | -| `reasoning` | *string* | :heavy_check_mark: | Reasoning/thinking output, if any | null | \ No newline at end of file +| `completion` | *string* | ✅ | The completion output | The meaning of life is a philosophical question... | +| `reasoning` | *string* | ✅ | Reasoning/thinking output, if any | null | \ No newline at end of file diff --git a/docs/models/generationcontenterror.mdx b/docs/models/generationcontenterror.mdx index 10489c6c8..33699e78c 100644 --- a/docs/models/generationcontenterror.mdx +++ b/docs/models/generationcontenterror.mdx @@ -29,8 +29,8 @@ let value: GenerationContentError = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `message` | *string* | :heavy_check_mark: | Error message returned to the client | Timed out waiting for the provider | -| `previousErrors` | [models.GenerationContentErrorAttempt](../models/generationcontenterrorattempt.mdx)[] | :heavy_check_mark: | Every upstream attempt that failed before the returned error, in attempt order | | -| `providerName` | *string* | :heavy_check_mark: | Provider whose error was returned to the client, when known | Vertex | -| `raw` | *string* | :heavy_check_mark: | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | -| `status` | *number* | :heavy_check_mark: | HTTP status returned to the client | 504 | \ No newline at end of file +| `message` | *string* | ✅ | Error message returned to the client | Timed out waiting for the provider | +| `previousErrors` | [models.GenerationContentErrorAttempt](../models/generationcontenterrorattempt.mdx)[] | ✅ | Every upstream attempt that failed before the returned error, in attempt order | | +| `providerName` | *string* | ✅ | Provider whose error was returned to the client, when known | Vertex | +| `raw` | *string* | ✅ | Raw error body behind the returned error, when stored | \{"error":\{"code":504,"message":"Deadline exceeded"}} | +| `status` | *number* | ✅ | HTTP status returned to the client | 504 | \ No newline at end of file diff --git a/docs/models/generationcontenterrorattempt.mdx b/docs/models/generationcontenterrorattempt.mdx index cae0497af..fd79086a3 100644 --- a/docs/models/generationcontenterrorattempt.mdx +++ b/docs/models/generationcontenterrorattempt.mdx @@ -21,7 +21,7 @@ let value: GenerationContentErrorAttempt = { | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `code` | *number* | :heavy_check_mark: | HTTP status returned by this attempt | 429 | -| `message` | *string* | :heavy_check_mark: | Error message returned by this attempt | Provider returned error | -| `providerName` | *string* | :heavy_check_mark: | Provider that served this attempt, when known | Google | -| `raw` | *string* | :heavy_check_mark: | Raw error body returned by the provider, when stored | \{"error":\{"code":429,"message":"Resource exhausted"}} | \ No newline at end of file +| `code` | *number* | ✅ | HTTP status returned by this attempt | 429 | +| `message` | *string* | ✅ | Error message returned by this attempt | Provider returned error | +| `providerName` | *string* | ✅ | Provider that served this attempt, when known | Google | +| `raw` | *string* | ✅ | Raw error body returned by the provider, when stored | \{"error":\{"code":429,"message":"Resource exhausted"}} | \ No newline at end of file diff --git a/docs/models/generationcontentresponse.mdx b/docs/models/generationcontentresponse.mdx index 7858d9ecf..90b22e989 100644 --- a/docs/models/generationcontentresponse.mdx +++ b/docs/models/generationcontentresponse.mdx @@ -32,4 +32,4 @@ let value: GenerationContentResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.GenerationContentData](../models/generationcontentdata.mdx) | :heavy_check_mark: | Stored prompt and completion content, plus the failure error when one was stored | \{
"error": null,
"input": \{
"messages": [
\{
"content": "What is the meaning of life?",
"role": "user"
}
]
},
"output": \{
"completion": "The meaning of life is a philosophical question...",
"reasoning": null
}
} | \ No newline at end of file +| `data` | [models.GenerationContentData](../models/generationcontentdata.mdx) | ✅ | Stored prompt and completion content, plus the failure error when one was stored | \{
"error": null,
"input": \{
"messages": [
\{
"content": "What is the meaning of life?",
"role": "user"
}
]
},
"output": \{
"completion": "The meaning of life is a philosophical question...",
"reasoning": null
}
} | \ No newline at end of file diff --git a/docs/models/generationresponse.mdx b/docs/models/generationresponse.mdx index ffd25413d..88f25124d 100644 --- a/docs/models/generationresponse.mdx +++ b/docs/models/generationresponse.mdx @@ -61,4 +61,4 @@ let value: GenerationResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | [models.GenerationResponseData](../models/generationresponsedata.mdx) | :heavy_check_mark: | Generation data | \ No newline at end of file +| `data` | [models.GenerationResponseData](../models/generationresponsedata.mdx) | ✅ | Generation data | \ No newline at end of file diff --git a/docs/models/generationresponsedata.mdx b/docs/models/generationresponsedata.mdx index cd1791554..5422c0f56 100644 --- a/docs/models/generationresponsedata.mdx +++ b/docs/models/generationresponsedata.mdx @@ -63,48 +63,48 @@ let value: GenerationResponseData = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiType` | [models.ApiType](../models/apitype.mdx) | :heavy_check_mark: | Type of API used for the generation | | -| `appId` | *number* | :heavy_check_mark: | ID of the app that made the request | 12345 | -| `cacheDiscount` | *number* | :heavy_check_mark: | Discount applied due to caching | 0.0002 | -| `cancelled` | *boolean* | :heavy_check_mark: | Whether the generation was cancelled | false | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | -| `dataRegion` | [models.GenerationResponseDataRegion](../models/generationresponsedataregion.mdx) | :heavy_check_mark: | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | -| `externalUser` | *string* | :heavy_check_mark: | External user identifier | user-123 | -| `finishReason` | *string* | :heavy_check_mark: | Reason the generation finished | stop | -| `generationTime` | *number* | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | -| `httpReferer` | *string* | :heavy_check_mark: | Referer header from the request | | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | -| `isByok` | *boolean* | :heavy_check_mark: | Whether this used bring-your-own-key | false | -| `latency` | *number* | :heavy_check_mark: | Total latency in milliseconds | 1250 | -| `model` | *string* | :heavy_check_mark: | Model used for the generation | sao10k/l3-stheno-8b | -| `moderationLatency` | *number* | :heavy_check_mark: | Moderation latency in milliseconds | 50 | -| `nativeFinishReason` | *string* | :heavy_check_mark: | Native finish reason as reported by provider | stop | -| `nativeTokensCached` | *number* | :heavy_check_mark: | Native cached tokens as reported by provider | 3 | -| `nativeTokensCompletion` | *number* | :heavy_check_mark: | Native completion tokens as reported by provider | 25 | -| `nativeTokensCompletionImages` | *number* | :heavy_check_mark: | Native completion image tokens as reported by provider | 0 | -| `nativeTokensPrompt` | *number* | :heavy_check_mark: | Native prompt tokens as reported by provider | 10 | -| `nativeTokensReasoning` | *number* | :heavy_check_mark: | Native reasoning tokens as reported by provider | 5 | -| `numFetches` | *number* | :heavy_check_mark: | Number of web fetches performed | 0 | -| `numInputAudioPrompt` | *number* | :heavy_check_mark: | Number of audio inputs in the prompt | 0 | -| `numMediaCompletion` | *number* | :heavy_check_mark: | Number of media items in the completion | 0 | -| `numMediaPrompt` | *number* | :heavy_check_mark: | Number of media items in the prompt | 1 | -| `numSearchResults` | *number* | :heavy_check_mark: | Number of search results included | 5 | -| `origin` | *string* | :heavy_check_mark: | Origin URL of the request | https://openrouter.ai/ | -| `presetId` | *string* | :heavy_check_mark: | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | -| `providerName` | *string* | :heavy_check_mark: | Name of the provider that served the request | Infermatic | -| `providerResponses` | [models.ProviderResponse](../models/providerresponse.mdx)[] | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | -| `requestId` | *string* | :heavy_minus_sign: | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | -| `responseCacheSourceId` | *string* | :heavy_minus_sign: | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | -| `router` | *string* | :heavy_check_mark: | Router used for the request (e.g., openrouter/auto) | openrouter/auto | -| `serviceTier` | *string* | :heavy_check_mark: | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | -| `sessionId` | *string* | :heavy_minus_sign: | Session identifier grouping multiple generations in the same session | | -| `streamed` | *boolean* | :heavy_check_mark: | Whether the response was streamed | true | -| `tokensCompletion` | *number* | :heavy_check_mark: | Number of tokens in the completion | 25 | -| `tokensPrompt` | *number* | :heavy_check_mark: | Number of tokens in the prompt | 10 | -| `totalCost` | *number* | :heavy_check_mark: | Total cost of the generation in USD | 0.0015 | -| `upstreamId` | *string* | :heavy_check_mark: | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | -| `upstreamInferenceCost` | *number* | :heavy_check_mark: | Cost charged by the upstream provider | 0.0012 | -| `usage` | *number* | :heavy_check_mark: | Usage amount in USD | 0.0015 | -| `userAgent` | *string* | :heavy_check_mark: | User-Agent header from the request | | -| `webSearchEngine` | *string* | :heavy_check_mark: | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this generation is attributed to. Null for accounts without workspaces. Generations created before workspace resolution existed are attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiType` | [models.ApiType](../models/apitype.mdx) | ✅ | Type of API used for the generation | | +| `appId` | *number* | ✅ | ID of the app that made the request | 12345 | +| `cacheDiscount` | *number* | ✅ | Discount applied due to caching | 0.0002 | +| `cancelled` | *boolean* | ✅ | Whether the generation was cancelled | false | +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the generation was created | 2024-07-15T23:33:19.433273+00:00 | +| `dataRegion` | [models.GenerationResponseDataRegion](../models/generationresponsedataregion.mdx) | ✅ | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | +| `externalUser` | *string* | ✅ | External user identifier | user-123 | +| `finishReason` | *string* | ✅ | Reason the generation finished | stop | +| `generationTime` | *number* | ✅ | Time taken for generation in milliseconds | 1200 | +| `httpReferer` | *string* | ✅ | Referer header from the request | | +| `id` | *string* | ✅ | Unique identifier for the generation | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | +| `isByok` | *boolean* | ✅ | Whether this used bring-your-own-key | false | +| `latency` | *number* | ✅ | Total latency in milliseconds | 1250 | +| `model` | *string* | ✅ | Model used for the generation | sao10k/l3-stheno-8b | +| `moderationLatency` | *number* | ✅ | Moderation latency in milliseconds | 50 | +| `nativeFinishReason` | *string* | ✅ | Native finish reason as reported by provider | stop | +| `nativeTokensCached` | *number* | ✅ | Native cached tokens as reported by provider | 3 | +| `nativeTokensCompletion` | *number* | ✅ | Native completion tokens as reported by provider | 25 | +| `nativeTokensCompletionImages` | *number* | ✅ | Native completion image tokens as reported by provider | 0 | +| `nativeTokensPrompt` | *number* | ✅ | Native prompt tokens as reported by provider | 10 | +| `nativeTokensReasoning` | *number* | ✅ | Native reasoning tokens as reported by provider | 5 | +| `numFetches` | *number* | ✅ | Number of web fetches performed | 0 | +| `numInputAudioPrompt` | *number* | ✅ | Number of audio inputs in the prompt | 0 | +| `numMediaCompletion` | *number* | ✅ | Number of media items in the completion | 0 | +| `numMediaPrompt` | *number* | ✅ | Number of media items in the prompt | 1 | +| `numSearchResults` | *number* | ✅ | Number of search results included | 5 | +| `origin` | *string* | ✅ | Origin URL of the request | https://openrouter.ai/ | +| `presetId` | *string* | ✅ | ID of the preset used for this generation, null if no preset was used | a9e8d400-592a-494f-908c-375efa66cafd | +| `providerName` | *string* | ✅ | Name of the provider that served the request | Infermatic | +| `providerResponses` | [models.ProviderResponse](../models/providerresponse.mdx)[] | ✅ | List of provider responses for this generation, including fallback attempts | | +| `requestId` | *string* | ➖ | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | +| `responseCacheSourceId` | *string* | ➖ | If this generation was served from response cache, contains the original generation ID. Null otherwise. | | +| `router` | *string* | ✅ | Router used for the request (e.g., openrouter/auto) | openrouter/auto | +| `serviceTier` | *string* | ✅ | Service tier the upstream provider reported running this request on, or null if it did not report one. | priority | +| `sessionId` | *string* | ➖ | Session identifier grouping multiple generations in the same session | | +| `streamed` | *boolean* | ✅ | Whether the response was streamed | true | +| `tokensCompletion` | *number* | ✅ | Number of tokens in the completion | 25 | +| `tokensPrompt` | *number* | ✅ | Number of tokens in the prompt | 10 | +| `totalCost` | *number* | ✅ | Total cost of the generation in USD | 0.0015 | +| `upstreamId` | *string* | ✅ | Upstream provider's identifier for this generation | chatcmpl-791bcf62-080e-4568-87d0-94c72e3b4946 | +| `upstreamInferenceCost` | *number* | ✅ | Cost charged by the upstream provider | 0.0012 | +| `usage` | *number* | ✅ | Usage amount in USD | 0.0015 | +| `userAgent` | *string* | ✅ | User-Agent header from the request | | +| `webSearchEngine` | *string* | ✅ | The resolved web search engine used for this generation (e.g. exa, firecrawl, parallel) | exa | +| `workspaceId` | *string* | ✅ | ID of the workspace this generation is attributed to. Null for accounts without workspaces. Generations created before workspace resolution existed are attributed to the account default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/getbyokkeyresponse.mdx b/docs/models/getbyokkeyresponse.mdx index 4d8ee1a6d..7d649e067 100644 --- a/docs/models/getbyokkeyresponse.mdx +++ b/docs/models/getbyokkeyresponse.mdx @@ -32,4 +32,4 @@ let value: GetBYOKKeyResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.BYOKKey](../models/byokkey.mdx) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `data` | [models.BYOKKey](../models/byokkey.mdx) | ✅ | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/getguardrailresponse.mdx b/docs/models/getguardrailresponse.mdx index 59c7d81ce..7123f8f9c 100644 --- a/docs/models/getguardrailresponse.mdx +++ b/docs/models/getguardrailresponse.mdx @@ -22,4 +22,4 @@ let value: GetGuardrailResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Guardrail](../models/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `data` | [models.Guardrail](../models/guardrail.mdx) | ✅ | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/getobservabilitydestinationresponse.mdx b/docs/models/getobservabilitydestinationresponse.mdx index 9fba5385e..0c4134db5 100644 --- a/docs/models/getobservabilitydestinationresponse.mdx +++ b/docs/models/getobservabilitydestinationresponse.mdx @@ -39,4 +39,4 @@ let value: GetObservabilityDestinationResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *models.ObservabilityDestination* | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `data` | *models.ObservabilityDestination* | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/getpresetresponse.mdx b/docs/models/getpresetresponse.mdx index 359221c87..4681cb19e 100644 --- a/docs/models/getpresetresponse.mdx +++ b/docs/models/getpresetresponse.mdx @@ -43,4 +43,4 @@ let value: GetPresetResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.PresetWithDesignatedVersion](../models/presetwithdesignatedversion.mdx) | :heavy_check_mark: | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file +| `data` | [models.PresetWithDesignatedVersion](../models/presetwithdesignatedversion.mdx) | ✅ | A preset with its currently designated version. | \{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version": \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
},
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
} | \ No newline at end of file diff --git a/docs/models/getpresetversionresponse.mdx b/docs/models/getpresetversionresponse.mdx index 19a130f54..a4514263d 100644 --- a/docs/models/getpresetversionresponse.mdx +++ b/docs/models/getpresetversionresponse.mdx @@ -30,4 +30,4 @@ let value: GetPresetVersionResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.PresetDesignatedVersion](../models/presetdesignatedversion.mdx) | :heavy_check_mark: | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file +| `data` | [models.PresetDesignatedVersion](../models/presetdesignatedversion.mdx) | ✅ | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file diff --git a/docs/models/getscimgroupmappingresponse.mdx b/docs/models/getscimgroupmappingresponse.mdx index 391f00adb..3d1baa9a6 100644 --- a/docs/models/getscimgroupmappingresponse.mdx +++ b/docs/models/getscimgroupmappingresponse.mdx @@ -24,4 +24,4 @@ let value: GetScimGroupMappingResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.ScimGroupMapping](../models/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `data` | [models.ScimGroupMapping](../models/scimgroupmapping.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/getscimsyncjobresponse.mdx b/docs/models/getscimsyncjobresponse.mdx index 8e052f829..8c964766c 100644 --- a/docs/models/getscimsyncjobresponse.mdx +++ b/docs/models/getscimsyncjobresponse.mdx @@ -25,4 +25,4 @@ let value: GetScimSyncJobResponse = { | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `data` | [models.ScimSyncJob](../models/scimsyncjob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.ScimSyncJob](../models/scimsyncjob.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/gettoolresponse.mdx b/docs/models/gettoolresponse.mdx index 106b28d37..4fcb33d12 100644 --- a/docs/models/gettoolresponse.mdx +++ b/docs/models/gettoolresponse.mdx @@ -47,4 +47,4 @@ let value: GetToolResponse = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data` | [models.ServerToolDetails](../models/servertooldetails.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.ServerToolDetails](../models/servertooldetails.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/getworkspacebudgetresponse.mdx b/docs/models/getworkspacebudgetresponse.mdx index f262e5dc6..be176ba8c 100644 --- a/docs/models/getworkspacebudgetresponse.mdx +++ b/docs/models/getworkspacebudgetresponse.mdx @@ -23,5 +23,5 @@ let value: GetWorkspaceBudgetResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.WorkspaceBudget](../models/workspacebudget.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | -| `includeByokInBudgets` | *boolean* | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file +| `data` | [models.WorkspaceBudget](../models/workspacebudget.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | +| `includeByokInBudgets` | *boolean* | ➖ | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file diff --git a/docs/models/getworkspaceresponse.mdx b/docs/models/getworkspaceresponse.mdx index baf92dcdd..4cc287923 100644 --- a/docs/models/getworkspaceresponse.mdx +++ b/docs/models/getworkspaceresponse.mdx @@ -33,4 +33,4 @@ let value: GetWorkspaceResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Workspace](../models/workspace.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file +| `data` | [models.Workspace](../models/workspace.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/goneresponseerrordata.mdx b/docs/models/goneresponseerrordata.mdx index b13973a52..8b34de636 100644 --- a/docs/models/goneresponseerrordata.mdx +++ b/docs/models/goneresponseerrordata.mdx @@ -20,6 +20,6 @@ let value: GoneResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/guardrail.mdx b/docs/models/guardrail.mdx index 5c05f00ec..f558657e6 100644 --- a/docs/models/guardrail.mdx +++ b/docs/models/guardrail.mdx @@ -20,28 +20,28 @@ let value: Guardrail = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedDataRegions` | [models.GuardrailDataRegion](../models/guardraildataregion.mdx)[] | :heavy_minus_sign: | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. | [
"europe"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntry](../models/contentfilterbuiltinentry.mdx)[] | :heavy_minus_sign: | Builtin content filters applied to requests. Includes PII detectors and the regex-based prompt injection detector. | [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
] | -| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry.mdx)[] | :heavy_minus_sign: | Custom regex content filters applied to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | -| `description` | *string* | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | -| `enableFreeModelPublication` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enableFreeModelTraining` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `enablePaidModelTraining` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`enforceZdr`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | -| `enforceZdrAnthropic` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrGoogle` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrOpenai` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrOther` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | -| `enforceZdrXai` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `ignoredModels` | *string*[] | :heavy_minus_sign: | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | -| `ignoredProviders` | *string*[] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `includeByokInBudgets` | *boolean* | :heavy_check_mark: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. | false | -| `limitUsd` | *number* | :heavy_minus_sign: | Spending limit in USD | 100 | -| `name` | *string* | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | -| `updatedAt` | *string* | :heavy_minus_sign: | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace this guardrail belongs to, or `null` for an unscoped legacy guardrail predating workspaces. Workspace membership organizes the guardrail; it does not apply the guardrail to the workspace's traffic. A `null` value does not mean the default workspace, and does not apply the guardrail across every workspace. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `allowedDataRegions` | [models.GuardrailDataRegion](../models/guardraildataregion.mdx)[] | ➖ | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. | [
"europe"
] | +| `allowedModels` | *string*[] | ➖ | Array of model canonical_slugs (immutable identifiers) | [
"openai/gpt-5.2-20251211",
"anthropic/claude-4.5-opus-20251124",
"deepseek/deepseek-r1-0528:free"
] | +| `allowedProviders` | *string*[] | ➖ | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | +| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntry](../models/contentfilterbuiltinentry.mdx)[] | ➖ | Builtin content filters applied to requests. Includes PII detectors and the regex-based prompt injection detector. | [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
] | +| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry.mdx)[] | ➖ | Custom regex content filters applied to request messages | [
\{
"action": "redact",
"label": "[API_KEY]",
"pattern": "\\b(sk-[a-zA-Z0-9]\{48})\\b"
}
] | +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the guardrail was created | 2025-08-24T10:30:00Z | +| `description` | *string* | ➖ | Description of the guardrail | Guardrail for production environment | +| `enableFreeModelPublication` | *boolean* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enableFreeModelTraining` | *boolean* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `enablePaidModelTraining` | *boolean* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`enforceZdr`~~ | *boolean* | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | false | +| `enforceZdrAnthropic` | *boolean* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | false | +| `enforceZdrGoogle` | *boolean* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | false | +| `enforceZdrOpenai` | *boolean* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | false | +| `enforceZdrOther` | *boolean* | ➖ | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | false | +| `enforceZdrXai` | *boolean* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | false | +| `id` | *string* | ✅ | Unique identifier for the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `ignoredModels` | *string*[] | ➖ | Array of model canonical_slugs to exclude from routing | [
"openai/gpt-4o-mini-2024-07-18"
] | +| `ignoredProviders` | *string*[] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `includeByokInBudgets` | *boolean* | ✅ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. | false | +| `limitUsd` | *number* | ➖ | Spending limit in USD | 100 | +| `name` | *string* | ✅ | Name of the guardrail | Production Guardrail | +| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `updatedAt` | *string* | ➖ | ISO 8601 timestamp of when the guardrail was last updated | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | The workspace this guardrail belongs to, or `null` for an unscoped legacy guardrail predating workspaces. Workspace membership organizes the guardrail; it does not apply the guardrail to the workspace's traffic. A `null` value does not mean the default workspace, and does not apply the guardrail across every workspace. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/image.mdx b/docs/models/image.mdx index 7d3607ddb..9f4e3b084 100644 --- a/docs/models/image.mdx +++ b/docs/models/image.mdx @@ -19,5 +19,5 @@ let value: Image = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `imageUrl` | [models.BatchObjectImageUrl](../models/batchobjectimageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.ChoiceTypeImageURLEnum](../models/choicetypeimageurlenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [models.BatchObjectImageUrl](../models/batchobjectimageurl.mdx) | ✅ | N/A | +| `type` | [models.ChoiceTypeImageURLEnum](../models/choicetypeimageurlenum.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/imageendpoint.mdx b/docs/models/imageendpoint.mdx index 43dc17049..1612d3fcc 100644 --- a/docs/models/imageendpoint.mdx +++ b/docs/models/imageendpoint.mdx @@ -42,10 +42,10 @@ let value: ImageEndpoint = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedPassthroughParameters` | *string*[] | :heavy_check_mark: | Provider-specific options accepted under provider.options[provider_slug]. | [] | -| `pricing` | [models.ImagePricingEntry](../models/imagepricingentry.mdx)[] | :heavy_check_mark: | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | -| `providerName` | *string* | :heavy_check_mark: | Provider display name | Bytedance | -| `providerSlug` | *string* | :heavy_check_mark: | Provider slug | bytedance | -| `providerTag` | *string* | :heavy_check_mark: | Provider tag for request-side selection | bytedance | -| `supportedParameters` | Record\ | :heavy_check_mark: | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | -| `supportsStreaming` | *boolean* | :heavy_check_mark: | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file +| `allowedPassthroughParameters` | *string*[] | ✅ | Provider-specific options accepted under provider.options[provider_slug]. | [] | +| `pricing` | [models.ImagePricingEntry](../models/imagepricingentry.mdx)[] | ✅ | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | +| `providerName` | *string* | ✅ | Provider display name | Bytedance | +| `providerSlug` | *string* | ✅ | Provider slug | bytedance | +| `providerTag` | *string* | ✅ | Provider tag for request-side selection | bytedance | +| `supportedParameters` | Record\ | ✅ | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | +| `supportsStreaming` | *boolean* | ✅ | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file diff --git a/docs/models/imagegencallcompletedevent.mdx b/docs/models/imagegencallcompletedevent.mdx index 69aa2b19d..e12b9355c 100644 --- a/docs/models/imagegencallcompletedevent.mdx +++ b/docs/models/imagegencallcompletedevent.mdx @@ -21,7 +21,7 @@ let value: ImageGenCallCompletedEvent = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.image_generation_call.completed"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.image_generation_call.completed"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/imagegencallgeneratingevent.mdx b/docs/models/imagegencallgeneratingevent.mdx index edddee435..c31ed5ab6 100644 --- a/docs/models/imagegencallgeneratingevent.mdx +++ b/docs/models/imagegencallgeneratingevent.mdx @@ -21,7 +21,7 @@ let value: ImageGenCallGeneratingEvent = { | Field | Type | Required | Description | | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.image_generation_call.generating"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.image_generation_call.generating"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/imagegencallinprogressevent.mdx b/docs/models/imagegencallinprogressevent.mdx index 3757afef9..227e5aa0b 100644 --- a/docs/models/imagegencallinprogressevent.mdx +++ b/docs/models/imagegencallinprogressevent.mdx @@ -21,7 +21,7 @@ let value: ImageGenCallInProgressEvent = { | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.image_generation_call.in_progress"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.image_generation_call.in_progress"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/imagegencallpartialimageevent.mdx b/docs/models/imagegencallpartialimageevent.mdx index 785ae27e1..fc62ba1fd 100644 --- a/docs/models/imagegencallpartialimageevent.mdx +++ b/docs/models/imagegencallpartialimageevent.mdx @@ -23,9 +23,9 @@ let value: ImageGenCallPartialImageEvent = { | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `partialImageB64` | *string* | :heavy_check_mark: | N/A | -| `partialImageIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.image_generation_call.partial_image"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `partialImageB64` | *string* | ✅ | N/A | +| `partialImageIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.image_generation_call.partial_image"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/imagegencompletedevent.mdx b/docs/models/imagegencompletedevent.mdx index 912a30499..dbcf7001e 100644 --- a/docs/models/imagegencompletedevent.mdx +++ b/docs/models/imagegencompletedevent.mdx @@ -20,8 +20,8 @@ let value: ImageGenCompletedEvent = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `b64Json` | *string* | :heavy_check_mark: | Base64-encoded final image data | | -| `created` | *number* | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | | -| `mediaType` | *string* | :heavy_minus_sign: | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | -| `type` | *"image_generation.completed"* | :heavy_check_mark: | The event type | | -| `usage` | [models.ImageGenerationUsage](../models/imagegenerationusage.mdx) | :heavy_minus_sign: | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file +| `b64Json` | *string* | ✅ | Base64-encoded final image data | | +| `created` | *number* | ✅ | Unix timestamp (seconds) when the image was generated | | +| `mediaType` | *string* | ➖ | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | +| `type` | *"image_generation.completed"* | ✅ | The event type | | +| `usage` | [models.ImageGenerationUsage](../models/imagegenerationusage.mdx) | ➖ | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file diff --git a/docs/models/imagegeneration.mdx b/docs/models/imagegeneration.mdx index 81cdaba2c..611187446 100644 --- a/docs/models/imagegeneration.mdx +++ b/docs/models/imagegeneration.mdx @@ -28,6 +28,6 @@ let value: ImageGeneration = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `requestCount` | *number* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `requestCount` | *number* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/imagegenerationproviderpreferences.mdx b/docs/models/imagegenerationproviderpreferences.mdx index 0837c07c6..666baab7e 100644 --- a/docs/models/imagegenerationproviderpreferences.mdx +++ b/docs/models/imagegenerationproviderpreferences.mdx @@ -16,9 +16,9 @@ let value: ImageGenerationProviderPreferences = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowFallbacks` | *boolean* | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `ignore` | *models.ImageGenerationProviderPreferencesIgnore*[] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | -| `only` | *models.ImageGenerationProviderPreferencesOnly*[] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | -| `options` | [models.ImageGenerationProviderPreferencesOptions](../models/imagegenerationproviderpreferencesoptions.mdx) | :heavy_minus_sign: | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | -| `order` | *models.ImageGenerationProviderPreferencesOrder*[] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | -| `sort` | *models.ImageGenerationProviderPreferencesSort* | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | \ No newline at end of file +| `allowFallbacks` | *boolean* | ➖ | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | +| `ignore` | *models.ImageGenerationProviderPreferencesIgnore*[] | ➖ | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | +| `only` | *models.ImageGenerationProviderPreferencesOnly*[] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | +| `options` | [models.ImageGenerationProviderPreferencesOptions](../models/imagegenerationproviderpreferencesoptions.mdx) | ➖ | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | +| `order` | *models.ImageGenerationProviderPreferencesOrder*[] | ➖ | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | +| `sort` | *models.ImageGenerationProviderPreferencesSort* | ➖ | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | \ No newline at end of file diff --git a/docs/models/imagegenerationproviderpreferencesoptions.mdx b/docs/models/imagegenerationproviderpreferencesoptions.mdx index df2b72166..6cc3d3a13 100644 --- a/docs/models/imagegenerationproviderpreferencesoptions.mdx +++ b/docs/models/imagegenerationproviderpreferencesoptions.mdx @@ -16,149 +16,149 @@ let value: ImageGenerationProviderPreferencesOptions = {}; | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `oneai` | Record\ | :heavy_minus_sign: | N/A | -| `ai21` | Record\ | :heavy_minus_sign: | N/A | -| `aionLabs` | Record\ | :heavy_minus_sign: | N/A | -| `akashml` | Record\ | :heavy_minus_sign: | N/A | -| `alibaba` | Record\ | :heavy_minus_sign: | N/A | -| `amazonBedrock` | Record\ | :heavy_minus_sign: | N/A | -| `amazonBedrockClaudeOnAws` | Record\ | :heavy_minus_sign: | N/A | -| `amazonNova` | Record\ | :heavy_minus_sign: | N/A | -| `ambient` | Record\ | :heavy_minus_sign: | N/A | -| `anthropic` | Record\ | :heavy_minus_sign: | N/A | -| `anthropic2` | Record\ | :heavy_minus_sign: | N/A | -| `anyscale` | Record\ | :heavy_minus_sign: | N/A | -| `arceeAi` | Record\ | :heavy_minus_sign: | N/A | -| `assemblyai` | Record\ | :heavy_minus_sign: | N/A | -| `atlasCloud` | Record\ | :heavy_minus_sign: | N/A | -| `atoma` | Record\ | :heavy_minus_sign: | N/A | -| `avian` | Record\ | :heavy_minus_sign: | N/A | -| `azure` | Record\ | :heavy_minus_sign: | N/A | -| `baidu` | Record\ | :heavy_minus_sign: | N/A | -| `baseten` | Record\ | :heavy_minus_sign: | N/A | -| `blackForestLabs` | Record\ | :heavy_minus_sign: | N/A | -| `byteplus` | Record\ | :heavy_minus_sign: | N/A | -| `centml` | Record\ | :heavy_minus_sign: | N/A | -| `cerebras` | Record\ | :heavy_minus_sign: | N/A | -| `chutes` | Record\ | :heavy_minus_sign: | N/A | -| `cirrascale` | Record\ | :heavy_minus_sign: | N/A | -| `clarifai` | Record\ | :heavy_minus_sign: | N/A | -| `claudeOnAws` | Record\ | :heavy_minus_sign: | N/A | -| `cloudflare` | Record\ | :heavy_minus_sign: | N/A | -| `cohere` | Record\ | :heavy_minus_sign: | N/A | -| `coreweave` | Record\ | :heavy_minus_sign: | N/A | -| `cosine` | Record\ | :heavy_minus_sign: | N/A | -| `crofai` | Record\ | :heavy_minus_sign: | N/A | -| `crucible` | Record\ | :heavy_minus_sign: | N/A | -| `crusoe` | Record\ | :heavy_minus_sign: | N/A | -| `darkbloom` | Record\ | :heavy_minus_sign: | N/A | -| `databricks` | Record\ | :heavy_minus_sign: | N/A | -| `decart` | Record\ | :heavy_minus_sign: | N/A | -| `deepgram` | Record\ | :heavy_minus_sign: | N/A | -| `deepinfra` | Record\ | :heavy_minus_sign: | N/A | -| `deepseek` | Record\ | :heavy_minus_sign: | N/A | -| `dekallm` | Record\ | :heavy_minus_sign: | N/A | -| `digitalocean` | Record\ | :heavy_minus_sign: | N/A | -| `elevenlabs` | Record\ | :heavy_minus_sign: | N/A | -| `enfer` | Record\ | :heavy_minus_sign: | N/A | -| `fakeProvider` | Record\ | :heavy_minus_sign: | N/A | -| `featherless` | Record\ | :heavy_minus_sign: | N/A | -| `fireworks` | Record\ | :heavy_minus_sign: | N/A | -| `fishAudio` | Record\ | :heavy_minus_sign: | N/A | -| `friendli` | Record\ | :heavy_minus_sign: | N/A | -| `gmicloud` | Record\ | :heavy_minus_sign: | N/A | -| `googleAiStudio` | Record\ | :heavy_minus_sign: | N/A | -| `googleVertex` | Record\ | :heavy_minus_sign: | N/A | -| `gopomelo` | Record\ | :heavy_minus_sign: | N/A | -| `groq` | Record\ | :heavy_minus_sign: | N/A | -| `heygen` | Record\ | :heavy_minus_sign: | N/A | -| `huggingface` | Record\ | :heavy_minus_sign: | N/A | -| `hyperbolic` | Record\ | :heavy_minus_sign: | N/A | -| `hyperbolicQuantized` | Record\ | :heavy_minus_sign: | N/A | -| `inception` | Record\ | :heavy_minus_sign: | N/A | -| `inceptron` | Record\ | :heavy_minus_sign: | N/A | -| `inferactVllm` | Record\ | :heavy_minus_sign: | N/A | -| `inferenceNet` | Record\ | :heavy_minus_sign: | N/A | -| `infermatic` | Record\ | :heavy_minus_sign: | N/A | -| `inflection` | Record\ | :heavy_minus_sign: | N/A | -| `inocloud` | Record\ | :heavy_minus_sign: | N/A | -| `ioNet` | Record\ | :heavy_minus_sign: | N/A | -| `ionstream` | Record\ | :heavy_minus_sign: | N/A | -| `klusterai` | Record\ | :heavy_minus_sign: | N/A | -| `krea` | Record\ | :heavy_minus_sign: | N/A | -| `lambda` | Record\ | :heavy_minus_sign: | N/A | -| `lepton` | Record\ | :heavy_minus_sign: | N/A | -| `liquid` | Record\ | :heavy_minus_sign: | N/A | -| `lynn` | Record\ | :heavy_minus_sign: | N/A | -| `lynnPrivate` | Record\ | :heavy_minus_sign: | N/A | -| `makora` | Record\ | :heavy_minus_sign: | N/A | -| `mancer` | Record\ | :heavy_minus_sign: | N/A | -| `mancerOld` | Record\ | :heavy_minus_sign: | N/A | -| `mara` | Record\ | :heavy_minus_sign: | N/A | -| `meta` | Record\ | :heavy_minus_sign: | N/A | -| `minimax` | Record\ | :heavy_minus_sign: | N/A | -| `mistral` | Record\ | :heavy_minus_sign: | N/A | -| `modal` | Record\ | :heavy_minus_sign: | N/A | -| `modelrun` | Record\ | :heavy_minus_sign: | N/A | -| `modular` | Record\ | :heavy_minus_sign: | N/A | -| `moonshotai` | Record\ | :heavy_minus_sign: | N/A | -| `morph` | Record\ | :heavy_minus_sign: | N/A | -| `ncompass` | Record\ | :heavy_minus_sign: | N/A | -| `nearAi` | Record\ | :heavy_minus_sign: | N/A | -| `nebius` | Record\ | :heavy_minus_sign: | N/A | -| `nexAgi` | Record\ | :heavy_minus_sign: | N/A | -| `nextbit` | Record\ | :heavy_minus_sign: | N/A | -| `nineteen` | Record\ | :heavy_minus_sign: | N/A | -| `novita` | Record\ | :heavy_minus_sign: | N/A | -| `nvidia` | Record\ | :heavy_minus_sign: | N/A | -| `octoai` | Record\ | :heavy_minus_sign: | N/A | -| `ollama` | Record\ | :heavy_minus_sign: | N/A | -| `openInference` | Record\ | :heavy_minus_sign: | N/A | -| `openai` | Record\ | :heavy_minus_sign: | N/A | -| `parasail` | Record\ | :heavy_minus_sign: | N/A | -| `perceptron` | Record\ | :heavy_minus_sign: | N/A | -| `perplexity` | Record\ | :heavy_minus_sign: | N/A | -| `phala` | Record\ | :heavy_minus_sign: | N/A | -| `poolside` | Record\ | :heavy_minus_sign: | N/A | -| `primeintellect` | Record\ | :heavy_minus_sign: | N/A | -| `quiver` | Record\ | :heavy_minus_sign: | N/A | -| `recraft` | Record\ | :heavy_minus_sign: | N/A | -| `recursal` | Record\ | :heavy_minus_sign: | N/A | -| `reflection` | Record\ | :heavy_minus_sign: | N/A | -| `reka` | Record\ | :heavy_minus_sign: | N/A | -| `relace` | Record\ | :heavy_minus_sign: | N/A | -| `replicate` | Record\ | :heavy_minus_sign: | N/A | -| `respan` | Record\ | :heavy_minus_sign: | N/A | -| `runway` | Record\ | :heavy_minus_sign: | N/A | -| `sailResearch` | Record\ | :heavy_minus_sign: | N/A | -| `sakana` | Record\ | :heavy_minus_sign: | N/A | -| `sakanaAi` | Record\ | :heavy_minus_sign: | N/A | -| `sambanova` | Record\ | :heavy_minus_sign: | N/A | -| `sambanovaCloaked` | Record\ | :heavy_minus_sign: | N/A | -| `scaledown` | Record\ | :heavy_minus_sign: | N/A | -| `seed` | Record\ | :heavy_minus_sign: | N/A | -| `sfCompute` | Record\ | :heavy_minus_sign: | N/A | -| `siliconflow` | Record\ | :heavy_minus_sign: | N/A | -| `sourceful` | Record\ | :heavy_minus_sign: | N/A | -| `stealth` | Record\ | :heavy_minus_sign: | N/A | -| `stepfun` | Record\ | :heavy_minus_sign: | N/A | -| `streamlake` | Record\ | :heavy_minus_sign: | N/A | -| `switchpoint` | Record\ | :heavy_minus_sign: | N/A | -| `targon` | Record\ | :heavy_minus_sign: | N/A | -| `tencent` | Record\ | :heavy_minus_sign: | N/A | -| `tenstorrent` | Record\ | :heavy_minus_sign: | N/A | -| `thinkingmachines` | Record\ | :heavy_minus_sign: | N/A | -| `together` | Record\ | :heavy_minus_sign: | N/A | -| `togetherLite` | Record\ | :heavy_minus_sign: | N/A | -| `typesafe` | Record\ | :heavy_minus_sign: | N/A | -| `ubicloud` | Record\ | :heavy_minus_sign: | N/A | -| `unbiased` | Record\ | :heavy_minus_sign: | N/A | -| `upstage` | Record\ | :heavy_minus_sign: | N/A | -| `venice` | Record\ | :heavy_minus_sign: | N/A | -| `voyageai` | Record\ | :heavy_minus_sign: | N/A | -| `wafer` | Record\ | :heavy_minus_sign: | N/A | -| `wandb` | Record\ | :heavy_minus_sign: | N/A | -| `wandbLegacy` | Record\ | :heavy_minus_sign: | N/A | -| `xai` | Record\ | :heavy_minus_sign: | N/A | -| `xiaomi` | Record\ | :heavy_minus_sign: | N/A | -| `zAi` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `oneai` | Record\ | ➖ | N/A | +| `ai21` | Record\ | ➖ | N/A | +| `aionLabs` | Record\ | ➖ | N/A | +| `akashml` | Record\ | ➖ | N/A | +| `alibaba` | Record\ | ➖ | N/A | +| `amazonBedrock` | Record\ | ➖ | N/A | +| `amazonBedrockClaudeOnAws` | Record\ | ➖ | N/A | +| `amazonNova` | Record\ | ➖ | N/A | +| `ambient` | Record\ | ➖ | N/A | +| `anthropic` | Record\ | ➖ | N/A | +| `anthropic2` | Record\ | ➖ | N/A | +| `anyscale` | Record\ | ➖ | N/A | +| `arceeAi` | Record\ | ➖ | N/A | +| `assemblyai` | Record\ | ➖ | N/A | +| `atlasCloud` | Record\ | ➖ | N/A | +| `atoma` | Record\ | ➖ | N/A | +| `avian` | Record\ | ➖ | N/A | +| `azure` | Record\ | ➖ | N/A | +| `baidu` | Record\ | ➖ | N/A | +| `baseten` | Record\ | ➖ | N/A | +| `blackForestLabs` | Record\ | ➖ | N/A | +| `byteplus` | Record\ | ➖ | N/A | +| `centml` | Record\ | ➖ | N/A | +| `cerebras` | Record\ | ➖ | N/A | +| `chutes` | Record\ | ➖ | N/A | +| `cirrascale` | Record\ | ➖ | N/A | +| `clarifai` | Record\ | ➖ | N/A | +| `claudeOnAws` | Record\ | ➖ | N/A | +| `cloudflare` | Record\ | ➖ | N/A | +| `cohere` | Record\ | ➖ | N/A | +| `coreweave` | Record\ | ➖ | N/A | +| `cosine` | Record\ | ➖ | N/A | +| `crofai` | Record\ | ➖ | N/A | +| `crucible` | Record\ | ➖ | N/A | +| `crusoe` | Record\ | ➖ | N/A | +| `darkbloom` | Record\ | ➖ | N/A | +| `databricks` | Record\ | ➖ | N/A | +| `decart` | Record\ | ➖ | N/A | +| `deepgram` | Record\ | ➖ | N/A | +| `deepinfra` | Record\ | ➖ | N/A | +| `deepseek` | Record\ | ➖ | N/A | +| `dekallm` | Record\ | ➖ | N/A | +| `digitalocean` | Record\ | ➖ | N/A | +| `elevenlabs` | Record\ | ➖ | N/A | +| `enfer` | Record\ | ➖ | N/A | +| `fakeProvider` | Record\ | ➖ | N/A | +| `featherless` | Record\ | ➖ | N/A | +| `fireworks` | Record\ | ➖ | N/A | +| `fishAudio` | Record\ | ➖ | N/A | +| `friendli` | Record\ | ➖ | N/A | +| `gmicloud` | Record\ | ➖ | N/A | +| `googleAiStudio` | Record\ | ➖ | N/A | +| `googleVertex` | Record\ | ➖ | N/A | +| `gopomelo` | Record\ | ➖ | N/A | +| `groq` | Record\ | ➖ | N/A | +| `heygen` | Record\ | ➖ | N/A | +| `huggingface` | Record\ | ➖ | N/A | +| `hyperbolic` | Record\ | ➖ | N/A | +| `hyperbolicQuantized` | Record\ | ➖ | N/A | +| `inception` | Record\ | ➖ | N/A | +| `inceptron` | Record\ | ➖ | N/A | +| `inferactVllm` | Record\ | ➖ | N/A | +| `inferenceNet` | Record\ | ➖ | N/A | +| `infermatic` | Record\ | ➖ | N/A | +| `inflection` | Record\ | ➖ | N/A | +| `inocloud` | Record\ | ➖ | N/A | +| `ioNet` | Record\ | ➖ | N/A | +| `ionstream` | Record\ | ➖ | N/A | +| `klusterai` | Record\ | ➖ | N/A | +| `krea` | Record\ | ➖ | N/A | +| `lambda` | Record\ | ➖ | N/A | +| `lepton` | Record\ | ➖ | N/A | +| `liquid` | Record\ | ➖ | N/A | +| `lynn` | Record\ | ➖ | N/A | +| `lynnPrivate` | Record\ | ➖ | N/A | +| `makora` | Record\ | ➖ | N/A | +| `mancer` | Record\ | ➖ | N/A | +| `mancerOld` | Record\ | ➖ | N/A | +| `mara` | Record\ | ➖ | N/A | +| `meta` | Record\ | ➖ | N/A | +| `minimax` | Record\ | ➖ | N/A | +| `mistral` | Record\ | ➖ | N/A | +| `modal` | Record\ | ➖ | N/A | +| `modelrun` | Record\ | ➖ | N/A | +| `modular` | Record\ | ➖ | N/A | +| `moonshotai` | Record\ | ➖ | N/A | +| `morph` | Record\ | ➖ | N/A | +| `ncompass` | Record\ | ➖ | N/A | +| `nearAi` | Record\ | ➖ | N/A | +| `nebius` | Record\ | ➖ | N/A | +| `nexAgi` | Record\ | ➖ | N/A | +| `nextbit` | Record\ | ➖ | N/A | +| `nineteen` | Record\ | ➖ | N/A | +| `novita` | Record\ | ➖ | N/A | +| `nvidia` | Record\ | ➖ | N/A | +| `octoai` | Record\ | ➖ | N/A | +| `ollama` | Record\ | ➖ | N/A | +| `openInference` | Record\ | ➖ | N/A | +| `openai` | Record\ | ➖ | N/A | +| `parasail` | Record\ | ➖ | N/A | +| `perceptron` | Record\ | ➖ | N/A | +| `perplexity` | Record\ | ➖ | N/A | +| `phala` | Record\ | ➖ | N/A | +| `poolside` | Record\ | ➖ | N/A | +| `primeintellect` | Record\ | ➖ | N/A | +| `quiver` | Record\ | ➖ | N/A | +| `recraft` | Record\ | ➖ | N/A | +| `recursal` | Record\ | ➖ | N/A | +| `reflection` | Record\ | ➖ | N/A | +| `reka` | Record\ | ➖ | N/A | +| `relace` | Record\ | ➖ | N/A | +| `replicate` | Record\ | ➖ | N/A | +| `respan` | Record\ | ➖ | N/A | +| `runway` | Record\ | ➖ | N/A | +| `sailResearch` | Record\ | ➖ | N/A | +| `sakana` | Record\ | ➖ | N/A | +| `sakanaAi` | Record\ | ➖ | N/A | +| `sambanova` | Record\ | ➖ | N/A | +| `sambanovaCloaked` | Record\ | ➖ | N/A | +| `scaledown` | Record\ | ➖ | N/A | +| `seed` | Record\ | ➖ | N/A | +| `sfCompute` | Record\ | ➖ | N/A | +| `siliconflow` | Record\ | ➖ | N/A | +| `sourceful` | Record\ | ➖ | N/A | +| `stealth` | Record\ | ➖ | N/A | +| `stepfun` | Record\ | ➖ | N/A | +| `streamlake` | Record\ | ➖ | N/A | +| `switchpoint` | Record\ | ➖ | N/A | +| `targon` | Record\ | ➖ | N/A | +| `tencent` | Record\ | ➖ | N/A | +| `tenstorrent` | Record\ | ➖ | N/A | +| `thinkingmachines` | Record\ | ➖ | N/A | +| `together` | Record\ | ➖ | N/A | +| `togetherLite` | Record\ | ➖ | N/A | +| `typesafe` | Record\ | ➖ | N/A | +| `ubicloud` | Record\ | ➖ | N/A | +| `unbiased` | Record\ | ➖ | N/A | +| `upstage` | Record\ | ➖ | N/A | +| `venice` | Record\ | ➖ | N/A | +| `voyageai` | Record\ | ➖ | N/A | +| `wafer` | Record\ | ➖ | N/A | +| `wandb` | Record\ | ➖ | N/A | +| `wandbLegacy` | Record\ | ➖ | N/A | +| `xai` | Record\ | ➖ | N/A | +| `xiaomi` | Record\ | ➖ | N/A | +| `zAi` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/imagegenerationrequest.mdx b/docs/models/imagegenerationrequest.mdx index ac7ce2136..5e2b5c1f1 100644 --- a/docs/models/imagegenerationrequest.mdx +++ b/docs/models/imagegenerationrequest.mdx @@ -19,20 +19,20 @@ let value: ImageGenerationRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `aspectRatio` | [models.ImageGenerationRequestAspectRatio](../models/imagegenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | -| `background` | [models.ImageGenerationRequestBackground](../models/imagegenerationrequestbackground.mdx) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | -| `inputReferences` | [models.ContentPartImage](../models/contentpartimage.mdx)[] | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | -| `model` | *string* | :heavy_check_mark: | The image generation model to use | bytedance-seed/seedream-4.5 | -| `n` | *number* | :heavy_minus_sign: | Upper bound on the number of images to generate (1-10). Providers may return fewer images, and providers that only support single-image generation reject n > 1. | 1 | -| `outputCompression` | *number* | :heavy_minus_sign: | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | -| `outputFormat` | [models.ImageGenerationRequestOutputFormat](../models/imagegenerationrequestoutputformat.mdx) | :heavy_minus_sign: | Encoding of the returned image bytes. Most models produce raster formats (png, jpeg, webp). SVG is supported by vectorization models (e.g. Quiver) — the SVG markup is UTF-8 base64-encoded in `b64_json`. | png | -| `prompt` | *string* | :heavy_check_mark: | Text description of the desired image | a red panda astronaut floating in space, studio lighting | -| `provider` | [models.ImageGenerationProviderPreferences](../models/imagegenerationproviderpreferences.mdx) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | -| `quality` | [models.ImageGenerationRequestQuality](../models/imagegenerationrequestquality.mdx) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | -| `resolution` | [models.ImageGenerationRequestResolution](../models/imagegenerationrequestresolution.mdx) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | -| `seed` | *number* | :heavy_minus_sign: | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `size` | *string* | :heavy_minus_sign: | Optional. A convenience shorthand for output dimensions — pass a tier ("2K", "4K") or explicit pixels ("2048x2048") and we normalize it to the right dimensions for the chosen provider. A tier size is equivalent to setting `resolution` and combines with `aspect_ratio`. An explicit pixel size is authoritative: a mismatched `resolution` or `aspect_ratio` alongside it is rejected with a 400. | 2K | -| `stream` | *boolean* | :heavy_minus_sign: | If true, partial images are streamed as SSE events as they become available. Only supported by providers with native streaming (currently OpenAI). Non-streaming providers ignore this flag and return a buffered response. | | -| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `user` | *string* | :heavy_minus_sign: | A stable identifier for your end-users. Used to help detect and prevent abuse. Never sent to providers verbatim: for providers whose data policy requires user IDs, it is folded into a hashed, per-account upstream user identifier. | end-user-abc123 | \ No newline at end of file +| `aspectRatio` | [models.ImageGenerationRequestAspectRatio](../models/imagegenerationrequestaspectratio.mdx) | ➖ | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | +| `background` | [models.ImageGenerationRequestBackground](../models/imagegenerationrequestbackground.mdx) | ➖ | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | +| `inputReferences` | [models.ContentPartImage](../models/contentpartimage.mdx)[] | ➖ | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | +| `model` | *string* | ✅ | The image generation model to use | bytedance-seed/seedream-4.5 | +| `n` | *number* | ➖ | Upper bound on the number of images to generate (1-10). Providers may return fewer images, and providers that only support single-image generation reject n > 1. | 1 | +| `outputCompression` | *number* | ➖ | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | +| `outputFormat` | [models.ImageGenerationRequestOutputFormat](../models/imagegenerationrequestoutputformat.mdx) | ➖ | Encoding of the returned image bytes. Most models produce raster formats (png, jpeg, webp). SVG is supported by vectorization models (e.g. Quiver) — the SVG markup is UTF-8 base64-encoded in `b64_json`. | png | +| `prompt` | *string* | ✅ | Text description of the desired image | a red panda astronaut floating in space, studio lighting | +| `provider` | [models.ImageGenerationProviderPreferences](../models/imagegenerationproviderpreferences.mdx) | ➖ | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | +| `quality` | [models.ImageGenerationRequestQuality](../models/imagegenerationrequestquality.mdx) | ➖ | Rendering quality. Providers without a quality knob ignore this. | high | +| `resolution` | [models.ImageGenerationRequestResolution](../models/imagegenerationrequestresolution.mdx) | ➖ | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | +| `seed` | *number* | ➖ | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `size` | *string* | ➖ | Optional. A convenience shorthand for output dimensions — pass a tier ("2K", "4K") or explicit pixels ("2048x2048") and we normalize it to the right dimensions for the chosen provider. A tier size is equivalent to setting `resolution` and combines with `aspect_ratio`. An explicit pixel size is authoritative: a mismatched `resolution` or `aspect_ratio` alongside it is rejected with a 400. | 2K | +| `stream` | *boolean* | ➖ | If true, partial images are streamed as SSE events as they become available. Only supported by providers with native streaming (currently OpenAI). Non-streaming providers ignore this flag and return a buffered response. | | +| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `user` | *string* | ➖ | A stable identifier for your end-users. Used to help detect and prevent abuse. Never sent to providers verbatim: for providers whose data policy requires user IDs, it is folded into a hashed, per-account upstream user identifier. | end-user-abc123 | \ No newline at end of file diff --git a/docs/models/imagegenerationresponse.mdx b/docs/models/imagegenerationresponse.mdx index c4e00e3d6..0e09b8333 100644 --- a/docs/models/imagegenerationresponse.mdx +++ b/docs/models/imagegenerationresponse.mdx @@ -23,6 +23,6 @@ let value: ImageGenerationResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `created` | *number* | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | 1748372400 | -| `data` | [models.ImageGenerationResponseData](../models/imagegenerationresponsedata.mdx)[] | :heavy_check_mark: | Generated images | | -| `usage` | [models.ImageGenerationUsage](../models/imagegenerationusage.mdx) | :heavy_minus_sign: | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file +| `created` | *number* | ✅ | Unix timestamp (seconds) when the image was generated | 1748372400 | +| `data` | [models.ImageGenerationResponseData](../models/imagegenerationresponsedata.mdx)[] | ✅ | Generated images | | +| `usage` | [models.ImageGenerationUsage](../models/imagegenerationusage.mdx) | ➖ | Token and cost usage for the image generation request, when available | \{
"completion_tokens": 4175,
"cost": 0.04,
"prompt_tokens": 0,
"total_tokens": 4175
} | \ No newline at end of file diff --git a/docs/models/imagegenerationresponsedata.mdx b/docs/models/imagegenerationresponsedata.mdx index 576b0ff35..4943c73d8 100644 --- a/docs/models/imagegenerationresponsedata.mdx +++ b/docs/models/imagegenerationresponsedata.mdx @@ -16,5 +16,5 @@ let value: ImageGenerationResponseData = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `b64Json` | *string* | :heavy_check_mark: | Base64-encoded image bytes | | -| `mediaType` | *string* | :heavy_minus_sign: | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | \ No newline at end of file +| `b64Json` | *string* | ✅ | Base64-encoded image bytes | | +| `mediaType` | *string* | ➖ | Media type (MIME type) of the image, e.g. `image/png`, `image/jpeg`, `image/webp`, `image/svg+xml`. May be omitted if the format could not be determined. | image/png | \ No newline at end of file diff --git a/docs/models/imagegenerationservertool.mdx b/docs/models/imagegenerationservertool.mdx index bfbccf8e7..e9e86bf14 100644 --- a/docs/models/imagegenerationservertool.mdx +++ b/docs/models/imagegenerationservertool.mdx @@ -18,14 +18,14 @@ let value: ImageGenerationServerTool = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `background` | [models.ImageGenerationServerToolBackground](../models/imagegenerationservertoolbackground.mdx) | :heavy_minus_sign: | N/A | -| `inputFidelity` | [models.InputFidelity](../models/inputfidelity.mdx) | :heavy_minus_sign: | N/A | -| `inputImageMask` | [models.InputImageMask](../models/inputimagemask.mdx) | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_minus_sign: | N/A | -| `moderation` | [models.Moderation](../models/moderation.mdx) | :heavy_minus_sign: | N/A | -| `outputCompression` | *number* | :heavy_minus_sign: | N/A | -| `outputFormat` | [models.ImageGenerationServerToolOutputFormat](../models/imagegenerationservertooloutputformat.mdx) | :heavy_minus_sign: | N/A | -| `partialImages` | *number* | :heavy_minus_sign: | N/A | -| `quality` | [models.ImageGenerationServerToolQuality](../models/imagegenerationservertoolquality.mdx) | :heavy_minus_sign: | N/A | -| `size` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.ImageGenerationServerToolType](../models/imagegenerationservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `background` | [models.ImageGenerationServerToolBackground](../models/imagegenerationservertoolbackground.mdx) | ➖ | N/A | +| `inputFidelity` | [models.InputFidelity](../models/inputfidelity.mdx) | ➖ | N/A | +| `inputImageMask` | [models.InputImageMask](../models/inputimagemask.mdx) | ➖ | N/A | +| `model` | *string* | ➖ | N/A | +| `moderation` | [models.Moderation](../models/moderation.mdx) | ➖ | N/A | +| `outputCompression` | *number* | ➖ | N/A | +| `outputFormat` | [models.ImageGenerationServerToolOutputFormat](../models/imagegenerationservertooloutputformat.mdx) | ➖ | N/A | +| `partialImages` | *number* | ➖ | N/A | +| `quality` | [models.ImageGenerationServerToolQuality](../models/imagegenerationservertoolquality.mdx) | ➖ | N/A | +| `size` | *string* | ➖ | N/A | +| `type` | [models.ImageGenerationServerToolType](../models/imagegenerationservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/imagegenerationservertoolconfig.mdx b/docs/models/imagegenerationservertoolconfig.mdx index dda9d257c..94853a30b 100644 --- a/docs/models/imagegenerationservertoolconfig.mdx +++ b/docs/models/imagegenerationservertoolconfig.mdx @@ -16,5 +16,5 @@ let value: ImageGenerationServerToolConfig = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `model` | *string* | :heavy_minus_sign: | Which image generation model to use (e.g. "openai/gpt-5-image"). Defaults to "openai/gpt-5-image". | openai/gpt-5-image | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | \ No newline at end of file +| `model` | *string* | ➖ | Which image generation model to use (e.g. "openai/gpt-5-image"). Defaults to "openai/gpt-5-image". | openai/gpt-5-image | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | \ No newline at end of file diff --git a/docs/models/imagegenerationservertoolopenrouter.mdx b/docs/models/imagegenerationservertoolopenrouter.mdx index ecf497e69..163acf13d 100644 --- a/docs/models/imagegenerationservertoolopenrouter.mdx +++ b/docs/models/imagegenerationservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: ImageGenerationServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `parameters` | [models.ImageGenerationServerToolConfig](../models/imagegenerationservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:image_generation server tool. Accepts all image_config params (aspect_ratio, quality, size, background, output_format, output_compression, moderation, etc.) plus a model field. | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | -| `type` | [models.ImageGenerationServerToolOpenRouterType](../models/imagegenerationservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.ImageGenerationServerToolConfig](../models/imagegenerationservertoolconfig.mdx) | ➖ | Configuration for the openrouter:image_generation server tool. Accepts all image_config params (aspect_ratio, quality, size, background, output_format, output_compression, moderation, etc.) plus a model field. | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | +| `type` | [models.ImageGenerationServerToolOpenRouterType](../models/imagegenerationservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/imagegenerationusage.mdx b/docs/models/imagegenerationusage.mdx index 2a830af7e..8ebce24f8 100644 --- a/docs/models/imagegenerationusage.mdx +++ b/docs/models/imagegenerationusage.mdx @@ -20,16 +20,16 @@ let value: ImageGenerationUsage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | -| `completionTokens` | *number* | :heavy_check_mark: | The tokens generated | | -| `completionTokensDetails` | [models.ImageGenerationUsageCompletionTokensDetails](../models/imagegenerationusagecompletiontokensdetails.mdx) | :heavy_minus_sign: | N/A | | -| `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `iterations` | *models.AnthropicUsageIteration*[] | :heavy_minus_sign: | N/A | | -| `promptTokens` | *number* | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `promptTokensDetails` | [models.ImageGenerationUsagePromptTokensDetails](../models/imagegenerationusageprompttokensdetails.mdx) | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `serverToolUse` | [models.ImageGenerationUsageServerToolUse](../models/imagegenerationusageservertooluse.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | -| `serviceTier` | *string* | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | :heavy_minus_sign: | N/A | standard | -| `totalTokens` | *number* | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file +| `cacheCreation` | [models.AnthropicCacheCreation](../models/anthropiccachecreation.mdx) | ➖ | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `completionTokens` | *number* | ✅ | The tokens generated | | +| `completionTokensDetails` | [models.ImageGenerationUsageCompletionTokensDetails](../models/imagegenerationusagecompletiontokensdetails.mdx) | ➖ | N/A | | +| `cost` | *number* | ➖ | Cost of the completion | | +| `costDetails` | [models.CostDetails](../models/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `isByok` | *boolean* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `iterations` | *models.AnthropicUsageIteration*[] | ➖ | N/A | | +| `promptTokens` | *number* | ✅ | Including images, input audio, and tools if any | | +| `promptTokensDetails` | [models.ImageGenerationUsagePromptTokensDetails](../models/imagegenerationusageprompttokensdetails.mdx) | ➖ | Breakdown of tokens used in the prompt. | | +| `serverToolUse` | [models.ImageGenerationUsageServerToolUse](../models/imagegenerationusageservertooluse.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | | +| `serviceTier` | *string* | ➖ | The service tier used by the upstream provider for this request | | +| `speed` | [models.AnthropicSpeed](../models/anthropicspeed.mdx) | ➖ | N/A | standard | +| `totalTokens` | *number* | ✅ | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/imagegenerationusagecompletiontokensdetails.mdx b/docs/models/imagegenerationusagecompletiontokensdetails.mdx index b1b7ef3eb..ae3ce8a9e 100644 --- a/docs/models/imagegenerationusagecompletiontokensdetails.mdx +++ b/docs/models/imagegenerationusagecompletiontokensdetails.mdx @@ -14,6 +14,6 @@ let value: ImageGenerationUsageCompletionTokensDetails = {}; | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for audio output. | -| `imageTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for image output. | -| `reasoningTokens` | *number* | :heavy_minus_sign: | Tokens generated by the model for reasoning. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens generated by the model for audio output. | +| `imageTokens` | *number* | ➖ | Tokens generated by the model for image output. | +| `reasoningTokens` | *number* | ➖ | Tokens generated by the model for reasoning. | \ No newline at end of file diff --git a/docs/models/imagegenerationusageprompttokensdetails.mdx b/docs/models/imagegenerationusageprompttokensdetails.mdx index 9dd4d28c8..3d16ffc8c 100644 --- a/docs/models/imagegenerationusageprompttokensdetails.mdx +++ b/docs/models/imagegenerationusageprompttokensdetails.mdx @@ -16,8 +16,8 @@ let value: ImageGenerationUsagePromptTokensDetails = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `audioTokens` | *number* | :heavy_minus_sign: | Tokens used for input audio. | -| `cacheWriteTokens` | *number* | :heavy_minus_sign: | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | -| `cachedTokens` | *number* | :heavy_minus_sign: | Tokens cached by the endpoint. | -| `fileTokens` | *number* | :heavy_minus_sign: | Tokens used for input files/documents. | -| `videoTokens` | *number* | :heavy_minus_sign: | Tokens used for input video. | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Tokens used for input audio. | +| `cacheWriteTokens` | *number* | ➖ | Tokens written to cache. Only returned for models with explicit caching and cache write pricing. | +| `cachedTokens` | *number* | ➖ | Tokens cached by the endpoint. | +| `fileTokens` | *number* | ➖ | Tokens used for input files/documents. | +| `videoTokens` | *number* | ➖ | Tokens used for input video. | \ No newline at end of file diff --git a/docs/models/imagegenerationusageservertooluse.mdx b/docs/models/imagegenerationusageservertooluse.mdx index 296492085..e3df33a36 100644 --- a/docs/models/imagegenerationusageservertooluse.mdx +++ b/docs/models/imagegenerationusageservertooluse.mdx @@ -16,6 +16,6 @@ let value: ImageGenerationUsageServerToolUse = {}; | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `toolCallsExecuted` | *number* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `toolCallsRequested` | *number* | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `webSearchRequests` | *number* | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `toolCallsExecuted` | *number* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `toolCallsRequested` | *number* | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `webSearchRequests` | *number* | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/imagegenpartialimageevent.mdx b/docs/models/imagegenpartialimageevent.mdx index b8fc4b45f..9489ab3a3 100644 --- a/docs/models/imagegenpartialimageevent.mdx +++ b/docs/models/imagegenpartialimageevent.mdx @@ -20,6 +20,6 @@ let value: ImageGenPartialImageEvent = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `b64Json` | *string* | :heavy_check_mark: | Base64-encoded partial image data | -| `partialImageIndex` | *number* | :heavy_check_mark: | 0-based index indicating which partial image this is in the sequence | -| `type` | *"image_generation.partial_image"* | :heavy_check_mark: | The event type | \ No newline at end of file +| `b64Json` | *string* | ✅ | Base64-encoded partial image data | +| `partialImageIndex` | *number* | ✅ | 0-based index indicating which partial image this is in the sequence | +| `type` | *"image_generation.partial_image"* | ✅ | The event type | \ No newline at end of file diff --git a/docs/models/imagegenstreamerrorevent.mdx b/docs/models/imagegenstreamerrorevent.mdx index ded909b38..857f2acc6 100644 --- a/docs/models/imagegenstreamerrorevent.mdx +++ b/docs/models/imagegenstreamerrorevent.mdx @@ -21,5 +21,5 @@ let value: ImageGenStreamErrorEvent = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `error` | [models.ImageGenStreamErrorEventError](../models/imagegenstreamerroreventerror.mdx) | :heavy_check_mark: | Provider error details | -| `type` | *"error"* | :heavy_check_mark: | The event type | \ No newline at end of file +| `error` | [models.ImageGenStreamErrorEventError](../models/imagegenstreamerroreventerror.mdx) | ✅ | Provider error details | +| `type` | *"error"* | ✅ | The event type | \ No newline at end of file diff --git a/docs/models/imagegenstreamerroreventerror.mdx b/docs/models/imagegenstreamerroreventerror.mdx index 7b2b267bc..c1ea2e51b 100644 --- a/docs/models/imagegenstreamerroreventerror.mdx +++ b/docs/models/imagegenstreamerroreventerror.mdx @@ -18,7 +18,7 @@ let value: ImageGenStreamErrorEventError = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `code` | *string* | :heavy_minus_sign: | Provider error code, when supplied | -| `message` | *string* | :heavy_check_mark: | Provider error message | -| `param` | *string* | :heavy_minus_sign: | Request parameter associated with the error, when supplied | -| `type` | *string* | :heavy_minus_sign: | Provider error type, when supplied | \ No newline at end of file +| `code` | *string* | ➖ | Provider error code, when supplied | +| `message` | *string* | ✅ | Provider error message | +| `param` | *string* | ➖ | Request parameter associated with the error, when supplied | +| `type` | *string* | ➖ | Provider error type, when supplied | \ No newline at end of file diff --git a/docs/models/imagegentextchunkevent.mdx b/docs/models/imagegentextchunkevent.mdx index 4e429b1c2..3cdd36cdb 100644 --- a/docs/models/imagegentextchunkevent.mdx +++ b/docs/models/imagegentextchunkevent.mdx @@ -20,6 +20,6 @@ let value: ImageGenTextChunkEvent = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `phase` | [models.ImageGenTextChunkEventPhase](../models/imagegentextchunkeventphase.mdx) | :heavy_check_mark: | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | -| `text` | *string* | :heavy_check_mark: | A text fragment of the image being generated (e.g. partial SVG markup) | -| `type` | *"image_generation.text_chunk"* | :heavy_check_mark: | The event type | \ No newline at end of file +| `phase` | [models.ImageGenTextChunkEventPhase](../models/imagegentextchunkeventphase.mdx) | ✅ | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | +| `text` | *string* | ✅ | A text fragment of the image being generated (e.g. partial SVG markup) | +| `type` | *"image_generation.text_chunk"* | ✅ | The event type | \ No newline at end of file diff --git a/docs/models/imagemodelarchitecture.mdx b/docs/models/imagemodelarchitecture.mdx index 73c1ce6e6..ab95b82fa 100644 --- a/docs/models/imagemodelarchitecture.mdx +++ b/docs/models/imagemodelarchitecture.mdx @@ -22,5 +22,5 @@ let value: ImageModelArchitecture = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `inputModalities` | [models.ImageInputModality](../models/imageinputmodality.mdx)[] | :heavy_check_mark: | Supported input modalities | -| `outputModalities` | [models.ImageOutputModality](../models/imageoutputmodality.mdx)[] | :heavy_check_mark: | Supported output modalities | \ No newline at end of file +| `inputModalities` | [models.ImageInputModality](../models/imageinputmodality.mdx)[] | ✅ | Supported input modalities | +| `outputModalities` | [models.ImageOutputModality](../models/imageoutputmodality.mdx)[] | ✅ | Supported output modalities | \ No newline at end of file diff --git a/docs/models/imagemodelendpointsresponse.mdx b/docs/models/imagemodelendpointsresponse.mdx index e02092521..ed392dcdc 100644 --- a/docs/models/imagemodelendpointsresponse.mdx +++ b/docs/models/imagemodelendpointsresponse.mdx @@ -44,5 +44,5 @@ let value: ImageModelEndpointsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `endpoints` | [models.ImageEndpoint](../models/imageendpoint.mdx)[] | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file +| `endpoints` | [models.ImageEndpoint](../models/imageendpoint.mdx)[] | ✅ | N/A | | +| `id` | *string* | ✅ | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file diff --git a/docs/models/imagemodellistitem.mdx b/docs/models/imagemodellistitem.mdx index 6ee6cf8b3..cace9ad6b 100644 --- a/docs/models/imagemodellistitem.mdx +++ b/docs/models/imagemodellistitem.mdx @@ -45,11 +45,11 @@ let value: ImageModelListItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [models.ImageModelArchitecture](../models/imagemodelarchitecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | -| `created` | *number* | :heavy_check_mark: | Unix timestamp (seconds) of when the model was created | 1692901234 | -| `description` | *string* | :heavy_check_mark: | N/A | A text-to-image model. | -| `endpoints` | *string* | :heavy_check_mark: | Relative URL to the full per-endpoint records for this model | /api/v1/images/models/bytedance-seed/seedream-4.5/endpoints | -| `id` | *string* | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | -| `name` | *string* | :heavy_check_mark: | Display name | Seedream 4.5 | -| `supportedParameters` | Record\ | :heavy_check_mark: | Union of supported parameters across every endpoint of this model. Coarse discovery aid; the definitive per-endpoint set is behind the endpoints URL. | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | -| `supportsStreaming` | *boolean* | :heavy_check_mark: | Whether any endpoint of this model supports native SSE streaming on the dedicated Image API (i.e. `stream: true` in the request). OR across endpoints. | false | \ No newline at end of file +| `architecture` | [models.ImageModelArchitecture](../models/imagemodelarchitecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | +| `created` | *number* | ✅ | Unix timestamp (seconds) of when the model was created | 1692901234 | +| `description` | *string* | ✅ | N/A | A text-to-image model. | +| `endpoints` | *string* | ✅ | Relative URL to the full per-endpoint records for this model | /api/v1/images/models/bytedance-seed/seedream-4.5/endpoints | +| `id` | *string* | ✅ | Model slug | bytedance-seed/seedream-4.5 | +| `name` | *string* | ✅ | Display name | Seedream 4.5 | +| `supportedParameters` | Record\ | ✅ | Union of supported parameters across every endpoint of this model. Coarse discovery aid; the definitive per-endpoint set is behind the endpoints URL. | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | +| `supportsStreaming` | *boolean* | ✅ | Whether any endpoint of this model supports native SSE streaming on the dedicated Image API (i.e. `stream: true` in the request). OR across endpoints. | false | \ No newline at end of file diff --git a/docs/models/imagemodelslistresponse.mdx b/docs/models/imagemodelslistresponse.mdx index 3c3e59192..1b630abb8 100644 --- a/docs/models/imagemodelslistresponse.mdx +++ b/docs/models/imagemodelslistresponse.mdx @@ -45,4 +45,4 @@ let value: ImageModelsListResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `data` | [models.ImageModelListItem](../models/imagemodellistitem.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.ImageModelListItem](../models/imagemodellistitem.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/imagepricingentry.mdx b/docs/models/imagepricingentry.mdx index 08b475de2..b75a1e543 100644 --- a/docs/models/imagepricingentry.mdx +++ b/docs/models/imagepricingentry.mdx @@ -20,7 +20,7 @@ let value: ImagePricingEntry = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `billable` | [models.Billable](../models/billable.mdx) | :heavy_check_mark: | N/A | -| `costUsd` | *number* | :heavy_check_mark: | N/A | -| `unit` | [models.Unit](../models/unit.mdx) | :heavy_check_mark: | N/A | -| `variant` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `billable` | [models.Billable](../models/billable.mdx) | ✅ | N/A | +| `costUsd` | *number* | ✅ | N/A | +| `unit` | [models.Unit](../models/unit.mdx) | ✅ | N/A | +| `variant` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/imagestreamingresponse.mdx b/docs/models/imagestreamingresponse.mdx index 2c66211d5..7fe5115e9 100644 --- a/docs/models/imagestreamingresponse.mdx +++ b/docs/models/imagestreamingresponse.mdx @@ -20,4 +20,4 @@ let value: ImageStreamingResponse = { | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `data` | *models.ImageStreamingResponseData* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *models.ImageStreamingResponseData* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/incompletedetails.mdx b/docs/models/incompletedetails.mdx index d07d5e78d..1df57075b 100644 --- a/docs/models/incompletedetails.mdx +++ b/docs/models/incompletedetails.mdx @@ -14,4 +14,4 @@ let value: IncompleteDetails = {}; | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `reason` | [models.IncompleteDetailsReason](../models/incompletedetailsreason.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `reason` | [models.IncompleteDetailsReason](../models/incompletedetailsreason.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/input1.mdx b/docs/models/input1.mdx index 43dfa655d..8fdf15734 100644 --- a/docs/models/input1.mdx +++ b/docs/models/input1.mdx @@ -16,4 +16,4 @@ let value: Input1 = { | Field | Type | Required | Description | Example | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `prompt` | *string* | :heavy_check_mark: | N/A | What is the meaning of life? | \ No newline at end of file +| `prompt` | *string* | ✅ | N/A | What is the meaning of life? | \ No newline at end of file diff --git a/docs/models/input2.mdx b/docs/models/input2.mdx index 785b350b9..77f714bed 100644 --- a/docs/models/input2.mdx +++ b/docs/models/input2.mdx @@ -21,4 +21,4 @@ let value: Input2 = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `messages` | *any*[] | :heavy_check_mark: | N/A | [
\{
"content": "What is the meaning of life?",
"role": "user"
}
] | \ No newline at end of file +| `messages` | *any*[] | ✅ | N/A | [
\{
"content": "What is the meaning of life?",
"role": "user"
}
] | \ No newline at end of file diff --git a/docs/models/inputaudio.mdx b/docs/models/inputaudio.mdx index eddc78187..06f5b4591 100644 --- a/docs/models/inputaudio.mdx +++ b/docs/models/inputaudio.mdx @@ -22,5 +22,5 @@ let value: InputAudio = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `inputAudio` | [models.InputAudioInputAudio](../models/inputaudioinputaudio.mdx) | :heavy_check_mark: | N/A | -| `type` | *"input_audio"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `inputAudio` | [models.InputAudioInputAudio](../models/inputaudioinputaudio.mdx) | ✅ | N/A | +| `type` | *"input_audio"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/inputaudioinputaudio.mdx b/docs/models/inputaudioinputaudio.mdx index 882e53d96..3a59f5cbd 100644 --- a/docs/models/inputaudioinputaudio.mdx +++ b/docs/models/inputaudioinputaudio.mdx @@ -17,5 +17,5 @@ let value: InputAudioInputAudio = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `data` | *string* | :heavy_check_mark: | N/A | -| `format` | [models.FormatEnum](../models/formatenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | *string* | ✅ | N/A | +| `format` | [models.FormatEnum](../models/formatenum.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/inputfile.mdx b/docs/models/inputfile.mdx index 9b40bb298..5460935fc 100644 --- a/docs/models/inputfile.mdx +++ b/docs/models/inputfile.mdx @@ -18,8 +18,8 @@ let value: InputFile = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `fileData` | *string* | :heavy_minus_sign: | N/A | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `fileUrl` | *string* | :heavy_minus_sign: | N/A | -| `filename` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_file"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileData` | *string* | ➖ | N/A | +| `fileId` | *string* | ➖ | N/A | +| `fileUrl` | *string* | ➖ | N/A | +| `filename` | *string* | ➖ | N/A | +| `type` | *"input_file"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/inputimage.mdx b/docs/models/inputimage.mdx index 5a6f15357..520e847fa 100644 --- a/docs/models/inputimage.mdx +++ b/docs/models/inputimage.mdx @@ -19,7 +19,7 @@ let value: InputImage = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `detail` | [models.InputImageDetail](../models/inputimagedetail.mdx) | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.InputImageTypeEnum](../models/inputimagetypeenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [models.InputImageDetail](../models/inputimagedetail.mdx) | ✅ | N/A | +| `fileId` | *string* | ➖ | N/A | +| `imageUrl` | *string* | ➖ | N/A | +| `type` | [models.InputImageTypeEnum](../models/inputimagetypeenum.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/inputimagemask.mdx b/docs/models/inputimagemask.mdx index 9a4f4892b..344add299 100644 --- a/docs/models/inputimagemask.mdx +++ b/docs/models/inputimagemask.mdx @@ -14,5 +14,5 @@ let value: InputImageMask = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `fileId` | *string* | ➖ | N/A | +| `imageUrl` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/inputmessageitem.mdx b/docs/models/inputmessageitem.mdx index e72d1dc90..c16ca117f 100644 --- a/docs/models/inputmessageitem.mdx +++ b/docs/models/inputmessageitem.mdx @@ -16,7 +16,7 @@ let value: InputMessageItem = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `content` | *models.InputMessageItemContentUnion*[] | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `role` | *models.InputMessageItemRoleUnion* | :heavy_check_mark: | N/A | -| `type` | [models.InputMessageItemTypeMessage](../models/inputmessageitemtypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | *models.InputMessageItemContentUnion*[] | ➖ | N/A | +| `id` | *string* | ➖ | N/A | +| `role` | *models.InputMessageItemRoleUnion* | ✅ | N/A | +| `type` | [models.InputMessageItemTypeMessage](../models/inputmessageitemtypemessage.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/inputmessageitemcontentinputimage.mdx b/docs/models/inputmessageitemcontentinputimage.mdx index ae4db955f..b3235b92d 100644 --- a/docs/models/inputmessageitemcontentinputimage.mdx +++ b/docs/models/inputmessageitemcontentinputimage.mdx @@ -19,7 +19,7 @@ let value: InputMessageItemContentInputImage = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `detail` | [models.InputMessageItemDetail](../models/inputmessageitemdetail.mdx) | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_minus_sign: | N/A | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | *"input_image"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `detail` | [models.InputMessageItemDetail](../models/inputmessageitemdetail.mdx) | ✅ | N/A | +| `fileId` | *string* | ➖ | N/A | +| `imageUrl` | *string* | ➖ | N/A | +| `type` | *"input_image"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/inputschema.mdx b/docs/models/inputschema.mdx index 651574d16..8c8eac084 100644 --- a/docs/models/inputschema.mdx +++ b/docs/models/inputschema.mdx @@ -14,7 +14,7 @@ let value: InputSchema = {}; | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `properties` | *any* | :heavy_minus_sign: | N/A | -| `required` | *string*[] | :heavy_minus_sign: | N/A | -| `type` | *string* | :heavy_minus_sign: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `properties` | *any* | ➖ | N/A | +| `required` | *string*[] | ➖ | N/A | +| `type` | *string* | ➖ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/inputsmessage.mdx b/docs/models/inputsmessage.mdx index 099e3abf2..1428f0b71 100644 --- a/docs/models/inputsmessage.mdx +++ b/docs/models/inputsmessage.mdx @@ -25,9 +25,9 @@ let value: InputsMessage = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.InputsContent2* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `phase` | *models.InputsPhaseUnion* | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `role` | [models.InputsRole](../models/inputsrole.mdx) | :heavy_check_mark: | N/A | -| `status` | *models.InputsStatusUnion1* | :heavy_minus_sign: | N/A | -| `type` | [models.InputsTypeMessage](../models/inputstypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | *models.InputsContent2* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `phase` | *models.InputsPhaseUnion* | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | +| `role` | [models.InputsRole](../models/inputsrole.mdx) | ✅ | N/A | +| `status` | *models.InputsStatusUnion1* | ➖ | N/A | +| `type` | [models.InputsTypeMessage](../models/inputstypemessage.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/inputsreasoning.mdx b/docs/models/inputsreasoning.mdx index a578b2f3a..27066e41d 100644 --- a/docs/models/inputsreasoning.mdx +++ b/docs/models/inputsreasoning.mdx @@ -25,11 +25,11 @@ let value: InputsReasoning = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | :heavy_minus_sign: | N/A | | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | *models.InputsStatusUnion2* | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | :heavy_check_mark: | N/A | | -| `type` | [models.InputsTypeReasoning](../models/inputstypereasoning.mdx) | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *string* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | ➖ | N/A | | +| `encryptedContent` | *string* | ➖ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `status` | *models.InputsStatusUnion2* | ➖ | N/A | | +| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | ✅ | N/A | | +| `type` | [models.InputsTypeReasoning](../models/inputstypereasoning.mdx) | ✅ | N/A | | +| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | ➖ | N/A | unknown | +| `signature` | *string* | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/inputtext.mdx b/docs/models/inputtext.mdx index 285d10e5c..a399e0a47 100644 --- a/docs/models/inputtext.mdx +++ b/docs/models/inputtext.mdx @@ -19,6 +19,6 @@ let value: InputText = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `promptCacheBreakpoint` | [models.PromptCacheBreakpoint](../models/promptcachebreakpoint.mdx) | :heavy_minus_sign: | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | -| `text` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"input_text"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `promptCacheBreakpoint` | [models.PromptCacheBreakpoint](../models/promptcachebreakpoint.mdx) | ➖ | Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Everything through the block carrying this marker is part of the candidate cached prefix. Supported natively by OpenAI GPT-5.6 and newer; on providers that use Anthropic-style `cache_control`, OpenRouter converts the marker to that format automatically. | \{
"mode": "explicit"
} | +| `text` | *string* | ✅ | N/A | | +| `type` | *"input_text"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/inputtokensdetails.mdx b/docs/models/inputtokensdetails.mdx index 5060dd8cc..533f3d710 100644 --- a/docs/models/inputtokensdetails.mdx +++ b/docs/models/inputtokensdetails.mdx @@ -16,5 +16,5 @@ let value: InputTokensDetails = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `cacheWriteTokens` | *number* | :heavy_minus_sign: | N/A | -| `cachedTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `cacheWriteTokens` | *number* | ➖ | N/A | +| `cachedTokens` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/inputvideo.mdx b/docs/models/inputvideo.mdx index 9085b1720..fc59d8d21 100644 --- a/docs/models/inputvideo.mdx +++ b/docs/models/inputvideo.mdx @@ -19,6 +19,6 @@ let value: InputVideo = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `processing` | [models.InputVideoProcessing](../models/inputvideoprocessing.mdx) | :heavy_minus_sign: | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | -| `type` | *"input_video"* | :heavy_check_mark: | N/A | | -| `videoUrl` | *string* | :heavy_check_mark: | A base64 data URL or remote URL that resolves to a video file | | \ No newline at end of file +| `processing` | [models.InputVideoProcessing](../models/inputvideoprocessing.mdx) | ➖ | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | +| `type` | *"input_video"* | ✅ | N/A | | +| `videoUrl` | *string* | ✅ | A base64 data URL or remote URL that resolves to a video file | | \ No newline at end of file diff --git a/docs/models/intern.mdx b/docs/models/intern.mdx index 06a0890f6..611430435 100644 --- a/docs/models/intern.mdx +++ b/docs/models/intern.mdx @@ -31,17 +31,17 @@ let value: Intern = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `attachedVaultId` | *string* | :heavy_check_mark: | Vault the intern borrows from another intern, or null when it borrows none. | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 creation time. | -| `description` | *string* | :heavy_check_mark: | Free-form description. | -| `hostname` | *string* | :heavy_check_mark: | Public hostname the intern is reachable at, or null until provisioning has assigned one. | -| `id` | *string* | :heavy_check_mark: | Intern id. | -| `instructions` | *string* | :heavy_check_mark: | Standing instructions the intern boots with. | -| `lastFailureMessage` | *string* | :heavy_check_mark: | Why the last provisioning attempt failed, when status is failed. | -| `model` | *string* | :heavy_check_mark: | OpenRouter model slug the intern runs, or null for the workspace default. | -| `name` | *string* | :heavy_check_mark: | Intern name, unique per creator within a workspace. | -| `progress` | [models.Progress](../models/progress.mdx) | :heavy_check_mark: | Active provisioning step, or null once provisioning has settled. | -| `status` | [models.InternStatus](../models/internstatus.mdx) | :heavy_check_mark: | Lifecycle status. | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 last update time. | -| `vaultId` | *string* | :heavy_check_mark: | Vault the intern owns, or null before it has been created. | -| `workspaceId` | *string* | :heavy_check_mark: | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file +| `attachedVaultId` | *string* | ✅ | Vault the intern borrows from another intern, or null when it borrows none. | +| `createdAt` | *string* | ✅ | ISO 8601 creation time. | +| `description` | *string* | ✅ | Free-form description. | +| `hostname` | *string* | ✅ | Public hostname the intern is reachable at, or null until provisioning has assigned one. | +| `id` | *string* | ✅ | Intern id. | +| `instructions` | *string* | ✅ | Standing instructions the intern boots with. | +| `lastFailureMessage` | *string* | ✅ | Why the last provisioning attempt failed, when status is failed. | +| `model` | *string* | ✅ | OpenRouter model slug the intern runs, or null for the workspace default. | +| `name` | *string* | ✅ | Intern name, unique per creator within a workspace. | +| `progress` | [models.Progress](../models/progress.mdx) | ✅ | Active provisioning step, or null once provisioning has settled. | +| `status` | [models.InternStatus](../models/internstatus.mdx) | ✅ | Lifecycle status. | +| `updatedAt` | *string* | ✅ | ISO 8601 last update time. | +| `vaultId` | *string* | ✅ | Vault the intern owns, or null before it has been created. | +| `workspaceId` | *string* | ✅ | Workspace that owns the intern and scopes its secrets. | \ No newline at end of file diff --git a/docs/models/internalserverresponseerrordata.mdx b/docs/models/internalserverresponseerrordata.mdx index f84ec9b9e..74e6242a3 100644 --- a/docs/models/internalserverresponseerrordata.mdx +++ b/docs/models/internalserverresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: InternalServerResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/internchatassistantmessage.mdx b/docs/models/internchatassistantmessage.mdx index edd6a443e..059f4ecea 100644 --- a/docs/models/internchatassistantmessage.mdx +++ b/docs/models/internchatassistantmessage.mdx @@ -18,6 +18,6 @@ let value: InternChatAssistantMessage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.InternChatMessageContent* | :heavy_minus_sign: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `role` | *"assistant"* | :heavy_check_mark: | N/A | | -| `toolCalls` | [models.InternChatEchoedToolCall](../models/internchatechoedtoolcall.mdx)[] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `content` | *models.InternChatMessageContent* | ➖ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `role` | *"assistant"* | ✅ | N/A | | +| `toolCalls` | [models.InternChatEchoedToolCall](../models/internchatechoedtoolcall.mdx)[] | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/internchatchoice.mdx b/docs/models/internchatchoice.mdx index cd425bd92..285bc349c 100644 --- a/docs/models/internchatchoice.mdx +++ b/docs/models/internchatchoice.mdx @@ -20,6 +20,6 @@ let value: InternChatChoice = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `delta` | [models.InternChatDelta](../models/internchatdelta.mdx) | :heavy_check_mark: | The incremental content of one chunk. The first chunk carries `role`, text chunks carry `content`, reasoning chunks carry `reasoning`, and an interaction chunk carries one complete `tool_calls` entry. | \{
"content": "Hello"
} | -| `finishReason` | [models.InternChatChoiceFinishReason](../models/internchatchoicefinishreason.mdx) | :heavy_check_mark: | `null` while streaming. `stop` when the run completed, `tool_calls` when the run is waiting for the caller to answer the streamed tool call, `error` on the terminal error chunk. | | -| `index` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `delta` | [models.InternChatDelta](../models/internchatdelta.mdx) | ✅ | The incremental content of one chunk. The first chunk carries `role`, text chunks carry `content`, reasoning chunks carry `reasoning`, and an interaction chunk carries one complete `tool_calls` entry. | \{
"content": "Hello"
} | +| `finishReason` | [models.InternChatChoiceFinishReason](../models/internchatchoicefinishreason.mdx) | ✅ | `null` while streaming. `stop` when the run completed, `tool_calls` when the run is waiting for the caller to answer the streamed tool call, `error` on the terminal error chunk. | | +| `index` | *number* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/internchatcompletionchunk.mdx b/docs/models/internchatcompletionchunk.mdx index 2ba88694a..732cdc215 100644 --- a/docs/models/internchatcompletionchunk.mdx +++ b/docs/models/internchatcompletionchunk.mdx @@ -28,11 +28,11 @@ let value: InternChatCompletionChunk = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `choices` | [models.InternChatChoice](../models/internchatchoice.mdx)[] | :heavy_check_mark: | One choice on content, tool-call and error chunks. Empty on the final chunk that carries `session_id`. | | -| `created` | *number* | :heavy_check_mark: | N/A | | -| `error` | [models.InternChatStreamError](../models/internchatstreamerror.mdx) | :heavy_minus_sign: | A failure after the response headers were sent. The chunk that carries it has `finish_reason: "error"`, then the final empty-`choices` chunk and `[DONE]` follow. Reasons here are `attachment_failed`, `busy`, `client_closed_request`, `interaction_not_pending`, `interaction_unknown`, `intern_unreachable`, `run_ended`, `stream_severed`, `timeout` or `turn_failed`. `run_ended` reports an ending the intern confirmed, such as a cancellation or a deadline, while `stream_severed` reports a connection lost without that confirmation. | \{
"code": 502,
"message": "The intern could not continue this run.",
"metadata": \{
"reason": "attachment_failed",
"retryable": false
}
} | -| `id` | *string* | :heavy_check_mark: | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | -| `model` | *string* | :heavy_check_mark: | The runtime's identifier for the model the intern is running, as the intern reports it. Each chunk carries the model from the event behind it: `openrouter/intern` on chunks emitted before the intern has reported one and on chunks the API emits itself (timeout, run-ended and severed-stream errors and their final usage chunk), even after an earlier chunk named a model. It can change within a stream. It is not an OpenRouter model slug, and the request `model` is never used. | | -| `object` | [models.InternChatCompletionChunkObject](../models/internchatcompletionchunkobject.mdx) | :heavy_check_mark: | N/A | | -| `sessionId` | *string* | :heavy_minus_sign: | On the final chunk of every response, the daemon session to continue with, or `null` when the run failed before the intern reported one. Send it as `session_id` on the next request, including the `tool` reply to an interaction. Session ids are client-visible and scoped to the intern's own daemon. | ses_7f3c9a | -| `usage` | [models.InternChatUsage](../models/internchatusage.mdx) | :heavy_minus_sign: | Token usage for the run as the daemon reported it, on the final chunk before `[DONE]`. `null` when the daemon reported none, and always `null` after `tool_calls` because the turn is not over. | \{
"completion_tokens": 12,
"prompt_tokens": 40,
"total_tokens": 52
} | \ No newline at end of file +| `choices` | [models.InternChatChoice](../models/internchatchoice.mdx)[] | ✅ | One choice on content, tool-call and error chunks. Empty on the final chunk that carries `session_id`. | | +| `created` | *number* | ✅ | N/A | | +| `error` | [models.InternChatStreamError](../models/internchatstreamerror.mdx) | ➖ | A failure after the response headers were sent. The chunk that carries it has `finish_reason: "error"`, then the final empty-`choices` chunk and `[DONE]` follow. Reasons here are `attachment_failed`, `busy`, `client_closed_request`, `interaction_not_pending`, `interaction_unknown`, `intern_unreachable`, `run_ended`, `stream_severed`, `timeout` or `turn_failed`. `run_ended` reports an ending the intern confirmed, such as a cancellation or a deadline, while `stream_severed` reports a connection lost without that confirmation. | \{
"code": 502,
"message": "The intern could not continue this run.",
"metadata": \{
"reason": "attachment_failed",
"retryable": false
}
} | +| `id` | *string* | ✅ | The completion id, constant for the whole response. | chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750 | +| `model` | *string* | ✅ | The runtime's identifier for the model the intern is running, as the intern reports it. Each chunk carries the model from the event behind it: `openrouter/intern` on chunks emitted before the intern has reported one and on chunks the API emits itself (timeout, run-ended and severed-stream errors and their final usage chunk), even after an earlier chunk named a model. It can change within a stream. It is not an OpenRouter model slug, and the request `model` is never used. | | +| `object` | [models.InternChatCompletionChunkObject](../models/internchatcompletionchunkobject.mdx) | ✅ | N/A | | +| `sessionId` | *string* | ➖ | On the final chunk of every response, the daemon session to continue with, or `null` when the run failed before the intern reported one. Send it as `session_id` on the next request, including the `tool` reply to an interaction. Session ids are client-visible and scoped to the intern's own daemon. | ses_7f3c9a | +| `usage` | [models.InternChatUsage](../models/internchatusage.mdx) | ➖ | Token usage for the run as the daemon reported it, on the final chunk before `[DONE]`. `null` when the daemon reported none, and always `null` after `tool_calls` because the turn is not over. | \{
"completion_tokens": 12,
"prompt_tokens": 40,
"total_tokens": 52
} | \ No newline at end of file diff --git a/docs/models/internchatcompletionrequest.mdx b/docs/models/internchatcompletionrequest.mdx index 27a2b4e3c..96aa7d4b6 100644 --- a/docs/models/internchatcompletionrequest.mdx +++ b/docs/models/internchatcompletionrequest.mdx @@ -24,8 +24,8 @@ let value: InternChatCompletionRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `approvalMode` | [models.InternApprovalMode](../models/internapprovalmode.mdx) | :heavy_minus_sign: | How the run started by this prompt handles tool approvals. `self-drive` (the default when omitted) consents on your behalf and runs the shell unsandboxed. `manual` asks you before an approval-bearing tool runs, as an `openrouter.provide_input` permission request, and keeps the shell sandboxed until an escalation is allowed. The mode applies to the run this prompt starts and is not remembered by the session. Repeat it on each new prompt that should use it. A `tool` reply continues the run under the mode it started with. | manual | -| `messages` | *models.InternChatMessage*[] | :heavy_check_mark: | The conversation. Only the last message is read. A last `user` message starts a run. A last `tool` message answers the interaction named by its `tool_call_id` and requires `session_id`. | | -| `model` | *string* | :heavy_minus_sign: | Accepted for OpenAI compatibility and never used. The intern runs the model configured on it (`PATCH` the intern to change it). Streamed chunks report the runtime's identifier for that model as the intern reports it, or `openrouter/intern` on chunks whose event carries no model (before the intern reports one, and on the chunks the API emits itself: the timeout, run-ended and severed-stream error chunks, the stop chunk of a replay that ends without a terminal daemon event, and the final usage chunk after any of them). A usage chunk that follows a daemon completion event carries the model the intern reported. | openrouter/intern | -| `sessionId` | *string* | :heavy_minus_sign: | The daemon session to continue, as returned in `session_id` on the final chunk of an earlier response. Omit it to start a new session. An id the intern has not seen before is not an error: it starts a new session under that id, so a mistyped id forks the conversation. Sessions are scoped to the intern's own daemon. Required when the last message has role `tool`. | ses_7f3c9a | -| `stream` | *true* | :heavy_check_mark: | Must be `true`. This endpoint only streams. `false` or an omitted `stream` is refused with `400` and reason `bad_request`. | true | \ No newline at end of file +| `approvalMode` | [models.InternApprovalMode](../models/internapprovalmode.mdx) | ➖ | How the run started by this prompt handles tool approvals. `self-drive` (the default when omitted) consents on your behalf and runs the shell unsandboxed. `manual` asks you before an approval-bearing tool runs, as an `openrouter.provide_input` permission request, and keeps the shell sandboxed until an escalation is allowed. The mode applies to the run this prompt starts and is not remembered by the session. Repeat it on each new prompt that should use it. A `tool` reply continues the run under the mode it started with. | manual | +| `messages` | *models.InternChatMessage*[] | ✅ | The conversation. Only the last message is read. A last `user` message starts a run. A last `tool` message answers the interaction named by its `tool_call_id` and requires `session_id`. | | +| `model` | *string* | ➖ | Accepted for OpenAI compatibility and never used. The intern runs the model configured on it (`PATCH` the intern to change it). Streamed chunks report the runtime's identifier for that model as the intern reports it, or `openrouter/intern` on chunks whose event carries no model (before the intern reports one, and on the chunks the API emits itself: the timeout, run-ended and severed-stream error chunks, the stop chunk of a replay that ends without a terminal daemon event, and the final usage chunk after any of them). A usage chunk that follows a daemon completion event carries the model the intern reported. | openrouter/intern | +| `sessionId` | *string* | ➖ | The daemon session to continue, as returned in `session_id` on the final chunk of an earlier response. Omit it to start a new session. An id the intern has not seen before is not an error: it starts a new session under that id, so a mistyped id forks the conversation. Sessions are scoped to the intern's own daemon. Required when the last message has role `tool`. | ses_7f3c9a | +| `stream` | *true* | ✅ | Must be `true`. This endpoint only streams. `false` or an omitted `stream` is refused with `400` and reason `bad_request`. | true | \ No newline at end of file diff --git a/docs/models/internchatdelta.mdx b/docs/models/internchatdelta.mdx index 2bdd00ee8..13f0b9544 100644 --- a/docs/models/internchatdelta.mdx +++ b/docs/models/internchatdelta.mdx @@ -16,7 +16,7 @@ let value: InternChatDelta = {}; | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `content` | *string* | :heavy_minus_sign: | N/A | -| `reasoning` | *string* | :heavy_minus_sign: | N/A | -| `role` | [models.InternChatDeltaRole](../models/internchatdeltarole.mdx) | :heavy_minus_sign: | N/A | -| `toolCalls` | [models.InternChatToolCall](../models/internchattoolcall.mdx)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | *string* | ➖ | N/A | +| `reasoning` | *string* | ➖ | N/A | +| `role` | [models.InternChatDeltaRole](../models/internchatdeltarole.mdx) | ➖ | N/A | +| `toolCalls` | [models.InternChatToolCall](../models/internchattoolcall.mdx)[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/internchatdevelopermessage.mdx b/docs/models/internchatdevelopermessage.mdx index 4362a8450..8ff11e2ee 100644 --- a/docs/models/internchatdevelopermessage.mdx +++ b/docs/models/internchatdevelopermessage.mdx @@ -19,5 +19,5 @@ let value: InternChatDeveloperMessage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.InternChatMessageContent* | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `role` | *"developer"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | *models.InternChatMessageContent* | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `role` | *"developer"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/internchatechoedtoolcall.mdx b/docs/models/internchatechoedtoolcall.mdx index 8149d58e1..64ea68843 100644 --- a/docs/models/internchatechoedtoolcall.mdx +++ b/docs/models/internchatechoedtoolcall.mdx @@ -23,5 +23,5 @@ let value: InternChatEchoedToolCall = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `function` | [models.InternChatEchoedToolCallFunction](../models/internchatechoedtoolcallfunction.mdx) | :heavy_check_mark: | The function name and JSON arguments string exactly as streamed. | \{
"arguments": "\{\"kind\":\"permission\",\"operation\":\"shell\",\"options\":[\"allow_once\",\"reject_once\"]}",
"name": "openrouter.provide_input"
} | -| `id` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `function` | [models.InternChatEchoedToolCallFunction](../models/internchatechoedtoolcallfunction.mdx) | ✅ | The function name and JSON arguments string exactly as streamed. | \{
"arguments": "\{\"kind\":\"permission\",\"operation\":\"shell\",\"options\":[\"allow_once\",\"reject_once\"]}",
"name": "openrouter.provide_input"
} | +| `id` | *string* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/internchatechoedtoolcallfunction.mdx b/docs/models/internchatechoedtoolcallfunction.mdx index 45faaeb03..e1e3e05c9 100644 --- a/docs/models/internchatechoedtoolcallfunction.mdx +++ b/docs/models/internchatechoedtoolcallfunction.mdx @@ -20,5 +20,5 @@ let value: InternChatEchoedToolCallFunction = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | +| `name` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/internchaterror.mdx b/docs/models/internchaterror.mdx index 7707fe274..dd75d7aa3 100644 --- a/docs/models/internchaterror.mdx +++ b/docs/models/internchaterror.mdx @@ -19,6 +19,6 @@ let value: InternChatError = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `code` | *number* | :heavy_check_mark: | The HTTP status of the response. | | -| `message` | *string* | :heavy_check_mark: | N/A | | -| `metadata` | [models.InternChatErrorMetadata](../models/internchaterrormetadata.mdx) | :heavy_minus_sign: | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file +| `code` | *number* | ✅ | The HTTP status of the response. | | +| `message` | *string* | ✅ | N/A | | +| `metadata` | [models.InternChatErrorMetadata](../models/internchaterrormetadata.mdx) | ➖ | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file diff --git a/docs/models/internchaterrormetadata.mdx b/docs/models/internchaterrormetadata.mdx index 30f18d2dd..9a024dec4 100644 --- a/docs/models/internchaterrormetadata.mdx +++ b/docs/models/internchaterrormetadata.mdx @@ -19,5 +19,5 @@ let value: InternChatErrorMetadata = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `reason` | [models.InternChatErrorMetadataReason](../models/internchaterrormetadatareason.mdx) | :heavy_check_mark: | A stable reason a client can branch on. | -| `retryable` | *boolean* | :heavy_check_mark: | Whether the same request may be sent again unchanged. Always `true` for the transient refusals — `busy`, `intern_not_ready`, `intern_unreachable`, `rate_limited`, `stream_severed` and `timeout` — and always `false` for the ones a retry cannot fix. For `turn_failed` it varies by failure and is the intern's own classification of what went wrong: `true` for an upstream overload, rate limit, timeout or transport fault, `false` for an authentication or bad-request failure that would be rejected the same way again. Branch on this field rather than on `reason` when deciding whether to retry. A `429`, and a `409` or `503` with reason `busy`, also carry a `Retry-After` header saying how long to wait. | \ No newline at end of file +| `reason` | [models.InternChatErrorMetadataReason](../models/internchaterrormetadatareason.mdx) | ✅ | A stable reason a client can branch on. | +| `retryable` | *boolean* | ✅ | Whether the same request may be sent again unchanged. Always `true` for the transient refusals — `busy`, `intern_not_ready`, `intern_unreachable`, `rate_limited`, `stream_severed` and `timeout` — and always `false` for the ones a retry cannot fix. For `turn_failed` it varies by failure and is the intern's own classification of what went wrong: `true` for an upstream overload, rate limit, timeout or transport fault, `false` for an authentication or bad-request failure that would be rejected the same way again. Branch on this field rather than on `reason` when deciding whether to retry. A `429`, and a `409` or `503` with reason `busy`, also carry a `Retry-After` header saying how long to wait. | \ No newline at end of file diff --git a/docs/models/internchatprompttokensdetails.mdx b/docs/models/internchatprompttokensdetails.mdx index fccc5f9c0..4f85a1bc6 100644 --- a/docs/models/internchatprompttokensdetails.mdx +++ b/docs/models/internchatprompttokensdetails.mdx @@ -18,4 +18,4 @@ let value: InternChatPromptTokensDetails = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `cachedTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `cachedTokens` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/internchatsteeredresponse.mdx b/docs/models/internchatsteeredresponse.mdx index 39495aaac..5a73b7f28 100644 --- a/docs/models/internchatsteeredresponse.mdx +++ b/docs/models/internchatsteeredresponse.mdx @@ -19,5 +19,5 @@ let value: InternChatSteeredResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `sessionId` | *string* | :heavy_check_mark: | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | -| `status` | [models.InternChatSteeredResponseStatus](../models/internchatsteeredresponsestatus.mdx) | :heavy_check_mark: | The message was handed to the turn already running on this session. | | \ No newline at end of file +| `sessionId` | *string* | ✅ | The session of the running turn the message was delivered to. | sess_01j9x0k4q7v8r2t3m6n5p8w9y1 | +| `status` | [models.InternChatSteeredResponseStatus](../models/internchatsteeredresponsestatus.mdx) | ✅ | The message was handed to the turn already running on this session. | | \ No newline at end of file diff --git a/docs/models/internchatstreamerror.mdx b/docs/models/internchatstreamerror.mdx index c754a9ceb..85fcd4763 100644 --- a/docs/models/internchatstreamerror.mdx +++ b/docs/models/internchatstreamerror.mdx @@ -23,6 +23,6 @@ let value: InternChatStreamError = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `code` | *number* | :heavy_check_mark: | The HTTP status this failure would have had before the stream opened. | | -| `message` | *string* | :heavy_check_mark: | N/A | | -| `metadata` | [models.InternChatErrorMetadata](../models/internchaterrormetadata.mdx) | :heavy_check_mark: | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file +| `code` | *number* | ✅ | The HTTP status this failure would have had before the stream opened. | | +| `message` | *string* | ✅ | N/A | | +| `metadata` | [models.InternChatErrorMetadata](../models/internchaterrormetadata.mdx) | ✅ | Machine-readable detail for the failure. | \{
"reason": "interaction_not_pending",
"retryable": false
} | \ No newline at end of file diff --git a/docs/models/internchatstreamingresponse.mdx b/docs/models/internchatstreamingresponse.mdx index f9c12b28d..5e9e388be 100644 --- a/docs/models/internchatstreamingresponse.mdx +++ b/docs/models/internchatstreamingresponse.mdx @@ -30,4 +30,4 @@ let value: InternChatStreamingResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.InternChatCompletionChunk](../models/internchatcompletionchunk.mdx) | :heavy_check_mark: | One `data:` line of the stream. A run streams a role chunk, content and reasoning chunks, then a finish chunk: `stop`, `tool_calls` (the run is paused for input) or `error` (with an `error` object). A final chunk with empty `choices` follows in every case, carrying `session_id` and `usage` (`null` unless the daemon reported usage, and always `null` after `tool_calls`). Every stream ends with `[DONE]`. | \{
"choices": [
\{
"delta": \{
"content": "Hello"
},
"finish_reason": null,
"index": 0
}
],
"created": 1789537541,
"id": "chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750",
"model": "openrouter/intern",
"object": "chat.completion.chunk"
} | \ No newline at end of file +| `data` | [models.InternChatCompletionChunk](../models/internchatcompletionchunk.mdx) | ✅ | One `data:` line of the stream. A run streams a role chunk, content and reasoning chunks, then a finish chunk: `stop`, `tool_calls` (the run is paused for input) or `error` (with an `error` object). A final chunk with empty `choices` follows in every case, carrying `session_id` and `usage` (`null` unless the daemon reported usage, and always `null` after `tool_calls`). Every stream ends with `[DONE]`. | \{
"choices": [
\{
"delta": \{
"content": "Hello"
},
"finish_reason": null,
"index": 0
}
],
"created": 1789537541,
"id": "chatcmpl-f727571a-3bad-4e0d-8a9e-f18f8cda9750",
"model": "openrouter/intern",
"object": "chat.completion.chunk"
} | \ No newline at end of file diff --git a/docs/models/internchatsystemmessage.mdx b/docs/models/internchatsystemmessage.mdx index f6dd79862..2059960d6 100644 --- a/docs/models/internchatsystemmessage.mdx +++ b/docs/models/internchatsystemmessage.mdx @@ -19,5 +19,5 @@ let value: InternChatSystemMessage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.InternChatMessageContent* | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `role` | *"system"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | *models.InternChatMessageContent* | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `role` | *"system"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/internchattextpart.mdx b/docs/models/internchattextpart.mdx index fa6a33c22..85ec7c737 100644 --- a/docs/models/internchattextpart.mdx +++ b/docs/models/internchattextpart.mdx @@ -19,5 +19,5 @@ let value: InternChatTextPart = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.InternChatTextPartType](../models/internchattextparttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *string* | ✅ | N/A | +| `type` | [models.InternChatTextPartType](../models/internchattextparttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/internchattoolcall.mdx b/docs/models/internchattoolcall.mdx index 5a5afa567..888d1d875 100644 --- a/docs/models/internchattoolcall.mdx +++ b/docs/models/internchattoolcall.mdx @@ -25,7 +25,7 @@ let value: InternChatToolCall = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `function` | [models.InternChatToolCallFunction](../models/internchattoolcallfunction.mdx) | :heavy_check_mark: | The single tool this endpoint calls, asking the caller for input. | \{
"arguments": "\{\"fields\":[\{\"name\":\"answer\",\"options\":[\"red\",\"blue\",\"Other\"],\"required\":true,\"type\":\"string\"}],\"kind\":\"elicitation\",\"message\":\"Which colour do you prefer?\"}",
"name": "openrouter.provide_input"
} | -| `id` | *string* | :heavy_check_mark: | The interaction id. Send it back as `tool_call_id` on the `tool` message that answers it. | 15e90ad6-5320-4a59-af4f-b371428154fa | -| `index` | *number* | :heavy_check_mark: | N/A | | -| `type` | [models.InternChatToolCallType](../models/internchattoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `function` | [models.InternChatToolCallFunction](../models/internchattoolcallfunction.mdx) | ✅ | The single tool this endpoint calls, asking the caller for input. | \{
"arguments": "\{\"fields\":[\{\"name\":\"answer\",\"options\":[\"red\",\"blue\",\"Other\"],\"required\":true,\"type\":\"string\"}],\"kind\":\"elicitation\",\"message\":\"Which colour do you prefer?\"}",
"name": "openrouter.provide_input"
} | +| `id` | *string* | ✅ | The interaction id. Send it back as `tool_call_id` on the `tool` message that answers it. | 15e90ad6-5320-4a59-af4f-b371428154fa | +| `index` | *number* | ✅ | N/A | | +| `type` | [models.InternChatToolCallType](../models/internchattoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/internchattoolcallfunction.mdx b/docs/models/internchattoolcallfunction.mdx index 1ff18793a..44d885e6b 100644 --- a/docs/models/internchattoolcallfunction.mdx +++ b/docs/models/internchattoolcallfunction.mdx @@ -20,5 +20,5 @@ let value: InternChatToolCallFunction = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | A JSON object string describing the interaction. A permission request is `{"kind":"permission","operation":,"options":[]}`. A question is `{"kind":"elicitation","message":,"fields":[]}`. | \{"fields":[\{"name":"answer","options":["red","blue","Other"],"required":true,"type":"string"}],"kind":"elicitation","message":"Which colour do you prefer?"} | -| `name` | [models.InternChatToolCallFunctionName](../models/internchattoolcallfunctionname.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *string* | ✅ | A JSON object string describing the interaction. A permission request is `{"kind":"permission","operation":,"options":[]}`. A question is `{"kind":"elicitation","message":,"fields":[]}`. | \{"fields":[\{"name":"answer","options":["red","blue","Other"],"required":true,"type":"string"}],"kind":"elicitation","message":"Which colour do you prefer?"} | +| `name` | [models.InternChatToolCallFunctionName](../models/internchattoolcallfunctionname.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/internchattoolmessage.mdx b/docs/models/internchattoolmessage.mdx index cc5cc50c4..4f31f0f14 100644 --- a/docs/models/internchattoolmessage.mdx +++ b/docs/models/internchattoolmessage.mdx @@ -20,6 +20,6 @@ let value: InternChatToolMessage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.InternChatMessageContent* | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `role` | *"tool"* | :heavy_check_mark: | N/A | | -| `toolCallId` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | *models.InternChatMessageContent* | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `role` | *"tool"* | ✅ | N/A | | +| `toolCallId` | *string* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/internchatusage.mdx b/docs/models/internchatusage.mdx index 1f59c835b..f590508a6 100644 --- a/docs/models/internchatusage.mdx +++ b/docs/models/internchatusage.mdx @@ -20,8 +20,8 @@ let value: InternChatUsage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `completionTokens` | *number* | :heavy_check_mark: | N/A | | -| `cost` | *number* | :heavy_minus_sign: | The cost of the run in USD, when the daemon reported one. | | -| `promptTokens` | *number* | :heavy_check_mark: | N/A | | -| `promptTokensDetails` | [models.InternChatPromptTokensDetails](../models/internchatprompttokensdetails.mdx) | :heavy_minus_sign: | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | -| `totalTokens` | *number* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `completionTokens` | *number* | ✅ | N/A | | +| `cost` | *number* | ➖ | The cost of the run in USD, when the daemon reported one. | | +| `promptTokens` | *number* | ✅ | N/A | | +| `promptTokensDetails` | [models.InternChatPromptTokensDetails](../models/internchatprompttokensdetails.mdx) | ➖ | Prompt tokens served from cache, when the daemon reported them. | \{
"cached_tokens": 1024
} | +| `totalTokens` | *number* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/internchatusermessage.mdx b/docs/models/internchatusermessage.mdx index 2b3c42b38..8dcc3a828 100644 --- a/docs/models/internchatusermessage.mdx +++ b/docs/models/internchatusermessage.mdx @@ -19,5 +19,5 @@ let value: InternChatUserMessage = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.InternChatMessageContent* | :heavy_check_mark: | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | -| `role` | *"user"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `content` | *models.InternChatMessageContent* | ✅ | Message text as a string or a list of text parts. Assistant history may carry null. Only the last message is read; earlier messages are accepted so ordinary clients can resend history. | Summarize the open pull requests. | +| `role` | *"user"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/interndaemonaccess.mdx b/docs/models/interndaemonaccess.mdx index 5710ce27b..584ddb4d0 100644 --- a/docs/models/interndaemonaccess.mdx +++ b/docs/models/interndaemonaccess.mdx @@ -19,5 +19,5 @@ let value: InternDaemonAccess = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `origin` | *string* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `origin` | *string* | ✅ | N/A | +| `token` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/interninvokeacceptedresponse.mdx b/docs/models/interninvokeacceptedresponse.mdx index d3a3fd46d..add65c283 100644 --- a/docs/models/interninvokeacceptedresponse.mdx +++ b/docs/models/interninvokeacceptedresponse.mdx @@ -19,5 +19,5 @@ let value: InternInvokeAcceptedResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `sessionId` | *string* | :heavy_check_mark: | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | -| `status` | [models.InternInvokeAcceptedResponseStatus](../models/interninvokeacceptedresponsestatus.mdx) | :heavy_check_mark: | `started` when a new run began. `steered` when the session already had a run going and the prompt was delivered into it instead. | started | \ No newline at end of file +| `sessionId` | *string* | ✅ | The session the run belongs to. Send it back to continue the conversation. | b51a0e21-368b-4780-a220-14655bf28c55 | +| `status` | [models.InternInvokeAcceptedResponseStatus](../models/interninvokeacceptedresponsestatus.mdx) | ✅ | `started` when a new run began. `steered` when the session already had a run going and the prompt was delivered into it instead. | started | \ No newline at end of file diff --git a/docs/models/interninvokerequest.mdx b/docs/models/interninvokerequest.mdx index 0de7268e6..e6341b2ef 100644 --- a/docs/models/interninvokerequest.mdx +++ b/docs/models/interninvokerequest.mdx @@ -19,5 +19,5 @@ let value: InternInvokeRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `input` | *string* | :heavy_check_mark: | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | -| `sessionId` | *string* | :heavy_minus_sign: | The session to run in. Send the `session_id` from an earlier `202` to continue that conversation, for example to hand the intern a decision on a case it is working. Omit it to start a new session. Only a `session_id` this endpoint issued to the same caller on the same intern is accepted; any other is refused with `404`. | b51a0e21-368b-4780-a220-14655bf28c55 | \ No newline at end of file +| `input` | *string* | ✅ | The prompt for the run, at most 32000 characters. | New support ticket 48213. Case token: ct_9f2c. Investigate and reply. | +| `sessionId` | *string* | ➖ | The session to run in. Send the `session_id` from an earlier `202` to continue that conversation, for example to hand the intern a decision on a case it is working. Omit it to start a new session. Only a `session_id` this endpoint issued to the same caller on the same intern is accepted; any other is refused with `404`. | b51a0e21-368b-4780-a220-14655bf28c55 | \ No newline at end of file diff --git a/docs/models/internlifecycleerrorerror.mdx b/docs/models/internlifecycleerrorerror.mdx index 41d89dac4..84afab75a 100644 --- a/docs/models/internlifecycleerrorerror.mdx +++ b/docs/models/internlifecycleerrorerror.mdx @@ -17,6 +17,6 @@ let value: InternLifecycleErrorError = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `code` | *models.Code* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | [models.InternLifecycleErrorMetadata](../models/internlifecycleerrormetadata.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *models.Code* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | [models.InternLifecycleErrorMetadata](../models/internlifecycleerrormetadata.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/internlifecycleerrormetadata.mdx b/docs/models/internlifecycleerrormetadata.mdx index cedd755fb..26bacee6a 100644 --- a/docs/models/internlifecycleerrormetadata.mdx +++ b/docs/models/internlifecycleerrormetadata.mdx @@ -17,5 +17,5 @@ let value: InternLifecycleErrorMetadata = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `reason` | *string* | :heavy_check_mark: | N/A | -| `retryable` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| `reason` | *string* | ✅ | N/A | +| `retryable` | *boolean* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/internlistresponse.mdx b/docs/models/internlistresponse.mdx index b2bcebeaf..e1b74d1e3 100644 --- a/docs/models/internlistresponse.mdx +++ b/docs/models/internlistresponse.mdx @@ -36,6 +36,6 @@ let value: InternListResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | [models.Intern](../models/intern.mdx)[] | :heavy_check_mark: | N/A | | -| `hasMore` | *boolean* | :heavy_check_mark: | True when more interns match the current filters. | | -| `nextCursor` | *string* | :heavy_minus_sign: | Opaque cursor, present when `has_more` is true. Pass it as `starting_after` to fetch the next page. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | \ No newline at end of file +| `data` | [models.Intern](../models/intern.mdx)[] | ✅ | N/A | | +| `hasMore` | *boolean* | ✅ | True when more interns match the current filters. | | +| `nextCursor` | *string* | ➖ | Opaque cursor, present when `has_more` is true. Pass it as `starting_after` to fetch the next page. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | \ No newline at end of file diff --git a/docs/models/itemreferenceitem.mdx b/docs/models/itemreferenceitem.mdx index 21defedc9..9ac258ac0 100644 --- a/docs/models/itemreferenceitem.mdx +++ b/docs/models/itemreferenceitem.mdx @@ -19,5 +19,5 @@ let value: ItemReferenceItem = { | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.ItemReferenceItemType](../models/itemreferenceitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `id` | *string* | ✅ | N/A | +| `type` | [models.ItemReferenceItemType](../models/itemreferenceitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/jevrouterplugin.mdx b/docs/models/jevrouterplugin.mdx index dae679c1f..8adb10011 100644 --- a/docs/models/jevrouterplugin.mdx +++ b/docs/models/jevrouterplugin.mdx @@ -16,7 +16,7 @@ let value: JevRouterPlugin = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | -| `excludedModels` | *string*[] | :heavy_minus_sign: | Remove these models from the router. Each entry is a model slug or a wildcard pattern (e.g. "xiaomi/*"). A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after `models`, so an excluded pattern always wins over an included one; when the lists leave no model the request can use, it fails with 404 rather than routing outside them. | [
"openai/gpt-6-astra",
"xiaomi/*"
] | -| `id` | *"jev-router"* | :heavy_check_mark: | N/A | | -| `models` | *string*[] | :heavy_minus_sign: | Restrict the router to these models. Each entry is a model slug or a wildcard pattern (e.g. "anthropic/*"), matched against the current pool; models outside the pool are ignored. A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When omitted or empty, every model in the pool is a candidate; when no pool model matches, the list is ignored and the whole pool is used (`excluded_models` still apply). `allowed_models` is an alias; entries from both fields are combined. | [
"anthropic/*",
"openai/gpt-5.6-sol"
] | \ No newline at end of file +| `allowedModels` | *string*[] | ➖ | Alias of `models`, matching the auto-router field name. Entries from both fields are combined. | [
"anthropic/*"
] | +| `excludedModels` | *string*[] | ➖ | Remove these models from the router. Each entry is a model slug or a wildcard pattern (e.g. "xiaomi/*"). A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. Applied after `models`, so an excluded pattern always wins over an included one; when the lists leave no model the request can use, it fails with 404 rather than routing outside them. | [
"openai/gpt-6-astra",
"xiaomi/*"
] | +| `id` | *"jev-router"* | ✅ | N/A | | +| `models` | *string*[] | ➖ | Restrict the router to these models. Each entry is a model slug or a wildcard pattern (e.g. "anthropic/*"), matched against the current pool; models outside the pool are ignored. A `~author/family-latest` alias matches every revision of that family. Up to 1024 patterns, each at most 1024 characters, with 65536 total characters across all patterns. When omitted or empty, every model in the pool is a candidate; when no pool model matches, the list is ignored and the whole pool is used (`excluded_models` still apply). `allowed_models` is an alias; entries from both fields are combined. | [
"anthropic/*",
"openai/gpt-5.6-sol"
] | \ No newline at end of file diff --git a/docs/models/keepall.mdx b/docs/models/keepall.mdx index 6fc61f5f9..c996011f6 100644 --- a/docs/models/keepall.mdx +++ b/docs/models/keepall.mdx @@ -16,4 +16,4 @@ let value: KeepAll = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `type` | [models.KeepType](../models/keeptype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.KeepType](../models/keeptype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/key.mdx b/docs/models/key.mdx index b3523b731..740daf560 100644 --- a/docs/models/key.mdx +++ b/docs/models/key.mdx @@ -22,10 +22,10 @@ let value: Key = { | Field | Type | Required | Description | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `alg` | [models.Alg](../models/alg.mdx) | :heavy_check_mark: | N/A | -| `crv` | [models.Crv](../models/crv.mdx) | :heavy_check_mark: | N/A | -| `kid` | *string* | :heavy_check_mark: | N/A | -| `kty` | [models.Kty](../models/kty.mdx) | :heavy_check_mark: | N/A | -| `use` | [models.Use](../models/use.mdx) | :heavy_check_mark: | N/A | -| `x` | *string* | :heavy_check_mark: | N/A | -| `y` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `alg` | [models.Alg](../models/alg.mdx) | ✅ | N/A | +| `crv` | [models.Crv](../models/crv.mdx) | ✅ | N/A | +| `kid` | *string* | ✅ | N/A | +| `kty` | [models.Kty](../models/kty.mdx) | ✅ | N/A | +| `use` | [models.Use](../models/use.mdx) | ✅ | N/A | +| `x` | *string* | ✅ | N/A | +| `y` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/keyassignment.mdx b/docs/models/keyassignment.mdx index ef6a0dc9d..8ff4943d2 100644 --- a/docs/models/keyassignment.mdx +++ b/docs/models/keyassignment.mdx @@ -22,10 +22,10 @@ let value: KeyAssignment = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `assignedBy` | *string* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrailId` | *string* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `keyHash` | *string* | :heavy_check_mark: | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | -| `keyLabel` | *string* | :heavy_check_mark: | Label of the API key | prod-key | -| `keyName` | *string* | :heavy_check_mark: | Name of the API key | Production Key | \ No newline at end of file +| `assignedBy` | *string* | ✅ | User ID of who made the assignment | user_abc123 | +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `guardrailId` | *string* | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `id` | *string* | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `keyHash` | *string* | ✅ | Hash of the assigned API key | c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93 | +| `keyLabel` | *string* | ✅ | Label of the API key | prod-key | +| `keyName` | *string* | ✅ | Name of the API key | Production Key | \ No newline at end of file diff --git a/docs/models/legacychatcontentvideo.mdx b/docs/models/legacychatcontentvideo.mdx index 6352b0bf6..ddebe57db 100644 --- a/docs/models/legacychatcontentvideo.mdx +++ b/docs/models/legacychatcontentvideo.mdx @@ -4,7 +4,7 @@ title: "~~LegacyChatContentVideo~~" Video input content part (legacy format - deprecated) -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Example Usage @@ -23,5 +23,5 @@ let value: LegacyChatContentVideo = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `type` | *"input_video"* | :heavy_check_mark: | N/A | | -| `videoUrl` | [models.LegacyChatContentVideoInput](../models/legacychatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `type` | *"input_video"* | ✅ | N/A | | +| `videoUrl` | [models.LegacyChatContentVideoInput](../models/legacychatcontentvideoinput.mdx) | ✅ | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/legacychatcontentvideoinput.mdx b/docs/models/legacychatcontentvideoinput.mdx index ade876abb..d2b3708f4 100644 --- a/docs/models/legacychatcontentvideoinput.mdx +++ b/docs/models/legacychatcontentvideoinput.mdx @@ -18,5 +18,5 @@ let value: LegacyChatContentVideoInput = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `processing` | [models.LegacyChatContentVideoInputProcessing](../models/legacychatcontentvideoinputprocessing.mdx) | :heavy_minus_sign: | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | -| `url` | *string* | :heavy_check_mark: | URL of the video (data: URLs supported) | | \ No newline at end of file +| `processing` | [models.LegacyChatContentVideoInputProcessing](../models/legacychatcontentvideoinputprocessing.mdx) | ➖ | Video processing mode. `agentic` enables agentic video processing and `static` forces fixed-rate frame sampling on providers that support it (currently Google Gemini). | agentic | +| `url` | *string* | ✅ | URL of the video (data: URLs supported) | | \ No newline at end of file diff --git a/docs/models/legacywebsearchservertool.mdx b/docs/models/legacywebsearchservertool.mdx index d105fcf28..fb7f9962a 100644 --- a/docs/models/legacywebsearchservertool.mdx +++ b/docs/models/legacywebsearchservertool.mdx @@ -18,12 +18,12 @@ let value: LegacyWebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `filters` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [models.LegacyWebSearchServerToolType](../models/legacywebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.WebSearchUserLocation](../models/websearchuserlocation.mdx) | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `filters` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `maxResults` | *number* | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `maxUses` | *number* | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `type` | [models.LegacyWebSearchServerToolType](../models/legacywebsearchservertooltype.mdx) | ✅ | N/A | | +| `userLocation` | [models.WebSearchUserLocation](../models/websearchuserlocation.mdx) | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/listbyokkeysresponse.mdx b/docs/models/listbyokkeysresponse.mdx index 20c6333d2..bf79cab67 100644 --- a/docs/models/listbyokkeysresponse.mdx +++ b/docs/models/listbyokkeysresponse.mdx @@ -35,5 +35,5 @@ let value: ListBYOKKeysResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | [models.BYOKKey](../models/byokkey.mdx)[] | :heavy_check_mark: | List of BYOK credentials. | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file +| `data` | [models.BYOKKey](../models/byokkey.mdx)[] | ✅ | List of BYOK credentials. | | +| `totalCount` | *number* | ✅ | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file diff --git a/docs/models/listendpointsresponse.mdx b/docs/models/listendpointsresponse.mdx index ed4b20bc2..6ecdc9726 100644 --- a/docs/models/listendpointsresponse.mdx +++ b/docs/models/listendpointsresponse.mdx @@ -84,9 +84,9 @@ let value: ListEndpointsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `architecture` | [models.Architecture](../models/architecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `description` | *string* | :heavy_check_mark: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `endpoints` | [models.PublicEndpoint](../models/publicendpoint.mdx)[] | :heavy_check_mark: | List of available endpoints for this model | | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `name` | *string* | :heavy_check_mark: | Display name of the model | GPT-4 | \ No newline at end of file +| `architecture` | [models.Architecture](../models/architecture.mdx) | ✅ | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `created` | *number* | ✅ | Unix timestamp of when the model was created | 1692901234 | +| `description` | *string* | ✅ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `endpoints` | [models.PublicEndpoint](../models/publicendpoint.mdx)[] | ✅ | List of available endpoints for this model | | +| `id` | *string* | ✅ | Unique identifier for the model | openai/gpt-4 | +| `name` | *string* | ✅ | Display name of the model | GPT-4 | \ No newline at end of file diff --git a/docs/models/listendusersresponse.mdx b/docs/models/listendusersresponse.mdx index c6ce15cde..e01f4f360 100644 --- a/docs/models/listendusersresponse.mdx +++ b/docs/models/listendusersresponse.mdx @@ -24,5 +24,5 @@ let value: ListEndUsersResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `data` | [models.EndUser](../models/enduser.mdx)[] | :heavy_check_mark: | N/A | | -| `totalCount` | *number* | :heavy_check_mark: | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file +| `data` | [models.EndUser](../models/enduser.mdx)[] | ✅ | N/A | | +| `totalCount` | *number* | ✅ | Number of registrations matching the filters before pagination. | 1 | \ No newline at end of file diff --git a/docs/models/listguardrailsresponse.mdx b/docs/models/listguardrailsresponse.mdx index 4ea4eb8bd..a6710ee7b 100644 --- a/docs/models/listguardrailsresponse.mdx +++ b/docs/models/listguardrailsresponse.mdx @@ -25,5 +25,5 @@ let value: ListGuardrailsResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `data` | [models.Guardrail](../models/guardrail.mdx)[] | :heavy_check_mark: | List of guardrails | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file +| `data` | [models.Guardrail](../models/guardrail.mdx)[] | ✅ | List of guardrails | | +| `totalCount` | *number* | ✅ | Total number of guardrails | 25 | \ No newline at end of file diff --git a/docs/models/listkeyassignmentsresponse.mdx b/docs/models/listkeyassignmentsresponse.mdx index 8b8926f86..09020b358 100644 --- a/docs/models/listkeyassignmentsresponse.mdx +++ b/docs/models/listkeyassignmentsresponse.mdx @@ -28,5 +28,5 @@ let value: ListKeyAssignmentsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `data` | [models.KeyAssignment](../models/keyassignment.mdx)[] | :heavy_check_mark: | List of key assignments | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file +| `data` | [models.KeyAssignment](../models/keyassignment.mdx)[] | ✅ | List of key assignments | | +| `totalCount` | *number* | ✅ | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/docs/models/listmemberassignmentsresponse.mdx b/docs/models/listmemberassignmentsresponse.mdx index 548abff2e..046f05f5e 100644 --- a/docs/models/listmemberassignmentsresponse.mdx +++ b/docs/models/listmemberassignmentsresponse.mdx @@ -26,5 +26,5 @@ let value: ListMemberAssignmentsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data` | [models.MemberAssignment](../models/memberassignment.mdx)[] | :heavy_check_mark: | List of member assignments | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file +| `data` | [models.MemberAssignment](../models/memberassignment.mdx)[] | ✅ | List of member assignments | | +| `totalCount` | *number* | ✅ | Total number of member assignments | 10 | \ No newline at end of file diff --git a/docs/models/listobservabilitydestinationsresponse.mdx b/docs/models/listobservabilitydestinationsresponse.mdx index 348925ad0..e728a0079 100644 --- a/docs/models/listobservabilitydestinationsresponse.mdx +++ b/docs/models/listobservabilitydestinationsresponse.mdx @@ -42,5 +42,5 @@ let value: ListObservabilityDestinationsResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `data` | *models.ObservabilityDestination*[] | :heavy_check_mark: | List of observability destinations. | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of destinations matching the filters. | 1 | \ No newline at end of file +| `data` | *models.ObservabilityDestination*[] | ✅ | List of observability destinations. | | +| `totalCount` | *number* | ✅ | Total number of destinations matching the filters. | 1 | \ No newline at end of file diff --git a/docs/models/listpresetsresponse.mdx b/docs/models/listpresetsresponse.mdx index 932bd2e1c..5a92761d4 100644 --- a/docs/models/listpresetsresponse.mdx +++ b/docs/models/listpresetsresponse.mdx @@ -33,5 +33,5 @@ let value: ListPresetsResponse = { | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `data` | [models.Preset](../models/preset.mdx)[] | :heavy_check_mark: | N/A | -| `totalCount` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.Preset](../models/preset.mdx)[] | ✅ | N/A | +| `totalCount` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/listpresetversionsresponse.mdx b/docs/models/listpresetversionsresponse.mdx index 5efa47c6a..3b77f182f 100644 --- a/docs/models/listpresetversionsresponse.mdx +++ b/docs/models/listpresetversionsresponse.mdx @@ -33,5 +33,5 @@ let value: ListPresetVersionsResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data` | [models.PresetDesignatedVersion](../models/presetdesignatedversion.mdx)[] | :heavy_check_mark: | N/A | -| `totalCount` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.PresetDesignatedVersion](../models/presetdesignatedversion.mdx)[] | ✅ | N/A | +| `totalCount` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/listprivateendpointsresponse.mdx b/docs/models/listprivateendpointsresponse.mdx index 107f75d6d..98ecbc7f5 100644 --- a/docs/models/listprivateendpointsresponse.mdx +++ b/docs/models/listprivateendpointsresponse.mdx @@ -16,4 +16,4 @@ let value: ListPrivateEndpointsResponse = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [models.PrivateEndpointSummary](../models/privateendpointsummary.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.PrivateEndpointSummary](../models/privateendpointsummary.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/listscimgroupmappingsresponse.mdx b/docs/models/listscimgroupmappingsresponse.mdx index ae2d4e298..5aa4e05b6 100644 --- a/docs/models/listscimgroupmappingsresponse.mdx +++ b/docs/models/listscimgroupmappingsresponse.mdx @@ -27,5 +27,5 @@ let value: ListScimGroupMappingsResponse = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data` | [models.ScimGroupMapping](../models/scimgroupmapping.mdx)[] | :heavy_check_mark: | N/A | -| `totalCount` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.ScimGroupMapping](../models/scimgroupmapping.mdx)[] | ✅ | N/A | +| `totalCount` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/listscimgroupsresponse.mdx b/docs/models/listscimgroupsresponse.mdx index fa43be61a..c5f0a663c 100644 --- a/docs/models/listscimgroupsresponse.mdx +++ b/docs/models/listscimgroupsresponse.mdx @@ -26,5 +26,5 @@ let value: ListScimGroupsResponse = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `data` | [models.ScimGroup](../models/scimgroup.mdx)[] | :heavy_check_mark: | N/A | -| `totalCount` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.ScimGroup](../models/scimgroup.mdx)[] | ✅ | N/A | +| `totalCount` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/listtoolsresponse.mdx b/docs/models/listtoolsresponse.mdx index 11485ac4b..2405cb216 100644 --- a/docs/models/listtoolsresponse.mdx +++ b/docs/models/listtoolsresponse.mdx @@ -20,6 +20,6 @@ let value: ListToolsResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | [models.ServerTool](../models/servertool.mdx)[] | :heavy_check_mark: | N/A | | -| `links` | [models.ListToolsResponseLinks](../models/listtoolsresponselinks.mdx) | :heavy_check_mark: | N/A | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of tools | 12 | \ No newline at end of file +| `data` | [models.ServerTool](../models/servertool.mdx)[] | ✅ | N/A | | +| `links` | [models.ListToolsResponseLinks](../models/listtoolsresponselinks.mdx) | ✅ | N/A | | +| `totalCount` | *number* | ✅ | Total number of tools | 12 | \ No newline at end of file diff --git a/docs/models/listtoolsresponselinks.mdx b/docs/models/listtoolsresponselinks.mdx index f2e3b39c6..f3ded7a7c 100644 --- a/docs/models/listtoolsresponselinks.mdx +++ b/docs/models/listtoolsresponselinks.mdx @@ -16,4 +16,4 @@ let value: ListToolsResponseLinks = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `next` | *string* | :heavy_check_mark: | URL for the next page of results, or null if this is the last page | null | \ No newline at end of file +| `next` | *string* | ✅ | URL for the next page of results, or null if this is the last page | null | \ No newline at end of file diff --git a/docs/models/listworkspacebudgetsresponse.mdx b/docs/models/listworkspacebudgetsresponse.mdx index b93677518..fe3de46fe 100644 --- a/docs/models/listworkspacebudgetsresponse.mdx +++ b/docs/models/listworkspacebudgetsresponse.mdx @@ -25,5 +25,5 @@ let value: ListWorkspaceBudgetsResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.WorkspaceBudget](../models/workspacebudget.mdx)[] | :heavy_check_mark: | List of budgets configured for the workspace | | -| `includeByokInBudgets` | *boolean* | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | false | \ No newline at end of file +| `data` | [models.WorkspaceBudget](../models/workspacebudget.mdx)[] | ✅ | List of budgets configured for the workspace | | +| `includeByokInBudgets` | *boolean* | ➖ | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | false | \ No newline at end of file diff --git a/docs/models/listworkspacemembersresponse.mdx b/docs/models/listworkspacemembersresponse.mdx index fc28a3bef..05536bb81 100644 --- a/docs/models/listworkspacemembersresponse.mdx +++ b/docs/models/listworkspacemembersresponse.mdx @@ -25,5 +25,5 @@ let value: ListWorkspaceMembersResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | [models.WorkspaceMember](../models/workspacemember.mdx)[] | :heavy_check_mark: | List of workspace members | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of members in the workspace | 5 | \ No newline at end of file +| `data` | [models.WorkspaceMember](../models/workspacemember.mdx)[] | ✅ | List of workspace members | | +| `totalCount` | *number* | ✅ | Total number of members in the workspace | 5 | \ No newline at end of file diff --git a/docs/models/listworkspacesresponse.mdx b/docs/models/listworkspacesresponse.mdx index 419b443e1..3772fe2ac 100644 --- a/docs/models/listworkspacesresponse.mdx +++ b/docs/models/listworkspacesresponse.mdx @@ -36,5 +36,5 @@ let value: ListWorkspacesResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `data` | [models.Workspace](../models/workspace.mdx)[] | :heavy_check_mark: | List of workspaces | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of workspaces | 5 | \ No newline at end of file +| `data` | [models.Workspace](../models/workspace.mdx)[] | ✅ | List of workspaces | | +| `totalCount` | *number* | ✅ | Total number of workspaces | 5 | \ No newline at end of file diff --git a/docs/models/localshellcallitem.mdx b/docs/models/localshellcallitem.mdx index 37dc59e85..c71d21a8d 100644 --- a/docs/models/localshellcallitem.mdx +++ b/docs/models/localshellcallitem.mdx @@ -31,8 +31,8 @@ let value: LocalShellCallItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `action` | [models.LocalShellCallItemAction](../models/localshellcallitemaction.mdx) | :heavy_check_mark: | N/A | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.TypeLocalShellCall](../models/typelocalshellcall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [models.LocalShellCallItemAction](../models/localshellcallitemaction.mdx) | ✅ | N/A | | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.TypeLocalShellCall](../models/typelocalshellcall.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/localshellcallitemaction.mdx b/docs/models/localshellcallitemaction.mdx index 6612238f1..030da869e 100644 --- a/docs/models/localshellcallitemaction.mdx +++ b/docs/models/localshellcallitemaction.mdx @@ -20,9 +20,9 @@ let value: LocalShellCallItemAction = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `command` | *string*[] | :heavy_check_mark: | N/A | -| `env` | Record\ | :heavy_check_mark: | N/A | -| `timeoutMs` | *number* | :heavy_minus_sign: | N/A | -| `type` | [models.TypeExec](../models/typeexec.mdx) | :heavy_check_mark: | N/A | -| `user` | *string* | :heavy_minus_sign: | N/A | -| `workingDirectory` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `command` | *string*[] | ✅ | N/A | +| `env` | Record\ | ✅ | N/A | +| `timeoutMs` | *number* | ➖ | N/A | +| `type` | [models.TypeExec](../models/typeexec.mdx) | ✅ | N/A | +| `user` | *string* | ➖ | N/A | +| `workingDirectory` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/localshellcalloutputitem.mdx b/docs/models/localshellcalloutputitem.mdx index ebf1237b6..5e6649180 100644 --- a/docs/models/localshellcalloutputitem.mdx +++ b/docs/models/localshellcalloutputitem.mdx @@ -20,7 +20,7 @@ let value: LocalShellCallOutputItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `output` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.LocalShellCallOutputItemType](../models/localshellcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *string* | ✅ | N/A | | +| `output` | *string* | ✅ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [models.LocalShellCallOutputItemType](../models/localshellcalloutputitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/logprob.mdx b/docs/models/logprob.mdx index 22564067b..9444a168c 100644 --- a/docs/models/logprob.mdx +++ b/docs/models/logprob.mdx @@ -21,7 +21,7 @@ let value: Logprob = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.ResponseOutputTextTopLogprob](../models/responseoutputtexttoplogprob.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes` | *number*[] | ✅ | N/A | +| `logprob` | *number* | ✅ | N/A | +| `token` | *string* | ✅ | N/A | +| `topLogprobs` | [models.ResponseOutputTextTopLogprob](../models/responseoutputtexttoplogprob.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/logprobs.mdx b/docs/models/logprobs.mdx index 978ad7010..44916d5bb 100644 --- a/docs/models/logprobs.mdx +++ b/docs/models/logprobs.mdx @@ -16,5 +16,5 @@ let value: Logprobs = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `content` | [models.LogprobsContent](../models/logprobscontent.mdx)[] | :heavy_check_mark: | N/A | -| `refusal` | [models.Refusal](../models/refusal.mdx)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | [models.LogprobsContent](../models/logprobscontent.mdx)[] | ✅ | N/A | +| `refusal` | [models.Refusal](../models/refusal.mdx)[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/logprobscontent.mdx b/docs/models/logprobscontent.mdx index 0173d0ed6..3512a2ec8 100644 --- a/docs/models/logprobscontent.mdx +++ b/docs/models/logprobscontent.mdx @@ -19,7 +19,7 @@ let value: LogprobsContent = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.ContentTopLogprob](../models/contenttoplogprob.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes` | *number*[] | ✅ | N/A | +| `logprob` | *number* | ✅ | N/A | +| `token` | *string* | ✅ | N/A | +| `topLogprobs` | [models.ContentTopLogprob](../models/contenttoplogprob.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/managedprivateendpoint.mdx b/docs/models/managedprivateendpoint.mdx index ab79730a4..b7d94745d 100644 --- a/docs/models/managedprivateendpoint.mdx +++ b/docs/models/managedprivateendpoint.mdx @@ -24,12 +24,12 @@ let value: ManagedPrivateEndpoint = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `modelName` | *string* | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `modelPermaslug` | *string* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `modelSlug` | *string* | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `providerName` | *string* | :heavy_check_mark: | Display name of the upstream provider. | Azure | -| `status` | [models.PrivateEndpointStatus](../models/privateendpointstatus.mdx) | :heavy_check_mark: | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | -| `declaredRegion` | [models.PrivateEndpointDeclaredRegion](../models/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `declaredZdr` | *boolean* | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | \ No newline at end of file +| `createdAt` | *string* | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `modelName` | *string* | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `modelPermaslug` | *string* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `modelSlug` | *string* | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `providerName` | *string* | ✅ | Display name of the upstream provider. | Azure | +| `status` | [models.PrivateEndpointStatus](../models/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | +| `declaredRegion` | [models.PrivateEndpointDeclaredRegion](../models/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `declaredZdr` | *boolean* | ✅ | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | \ No newline at end of file diff --git a/docs/models/managedprivateendpointresponse.mdx b/docs/models/managedprivateendpointresponse.mdx index f6db869a3..cebb1dfe4 100644 --- a/docs/models/managedprivateendpointresponse.mdx +++ b/docs/models/managedprivateendpointresponse.mdx @@ -26,4 +26,4 @@ let value: ManagedPrivateEndpointResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `data` | [models.ManagedPrivateEndpoint](../models/managedprivateendpoint.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.ManagedPrivateEndpoint](../models/managedprivateendpoint.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/maxprice.mdx b/docs/models/maxprice.mdx index 32c47ba09..97f834634 100644 --- a/docs/models/maxprice.mdx +++ b/docs/models/maxprice.mdx @@ -16,8 +16,8 @@ let value: MaxPrice = {}; | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `audio` | *string* | :heavy_minus_sign: | Maximum price in USD per audio unit | -| `completion` | *string* | :heavy_minus_sign: | Maximum price in USD per million completion tokens | -| `image` | *string* | :heavy_minus_sign: | Maximum price in USD per image | -| `prompt` | *string* | :heavy_minus_sign: | Maximum price in USD per million prompt tokens | -| `request` | *string* | :heavy_minus_sign: | Maximum price in USD per request | \ No newline at end of file +| `audio` | *string* | ➖ | Maximum price in USD per audio unit | +| `completion` | *string* | ➖ | Maximum price in USD per million completion tokens | +| `image` | *string* | ➖ | Maximum price in USD per image | +| `prompt` | *string* | ➖ | Maximum price in USD per million prompt tokens | +| `request` | *string* | ➖ | Maximum price in USD per request | \ No newline at end of file diff --git a/docs/models/mcpapprovalrequestitem.mdx b/docs/models/mcpapprovalrequestitem.mdx index f224845b5..43d85130c 100644 --- a/docs/models/mcpapprovalrequestitem.mdx +++ b/docs/models/mcpapprovalrequestitem.mdx @@ -22,8 +22,8 @@ let value: McpApprovalRequestItem = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.McpApprovalRequestItemType](../models/mcpapprovalrequestitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `name` | *string* | ✅ | N/A | +| `serverLabel` | *string* | ✅ | N/A | +| `type` | [models.McpApprovalRequestItemType](../models/mcpapprovalrequestitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/mcpapprovalresponseitem.mdx b/docs/models/mcpapprovalresponseitem.mdx index b26c49657..7a91571c0 100644 --- a/docs/models/mcpapprovalresponseitem.mdx +++ b/docs/models/mcpapprovalresponseitem.mdx @@ -20,8 +20,8 @@ let value: McpApprovalResponseItem = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `approvalRequestId` | *string* | :heavy_check_mark: | N/A | -| `approve` | *boolean* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `reason` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.McpApprovalResponseItemType](../models/mcpapprovalresponseitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `approvalRequestId` | *string* | ✅ | N/A | +| `approve` | *boolean* | ✅ | N/A | +| `id` | *string* | ➖ | N/A | +| `reason` | *string* | ➖ | N/A | +| `type` | [models.McpApprovalResponseItemType](../models/mcpapprovalresponseitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/mcpcallitem.mdx b/docs/models/mcpcallitem.mdx index 9a542f9a8..ebbbdae86 100644 --- a/docs/models/mcpcallitem.mdx +++ b/docs/models/mcpcallitem.mdx @@ -22,10 +22,10 @@ let value: McpCallItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `error` | *models.McpToolCallError* | :heavy_minus_sign: | Error from an MCP tool call, either a plain message or a structured error | \{
"code": 503,
"message": "Service Unavailable",
"type": "http_error"
} | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `output` | *string* | :heavy_minus_sign: | N/A | | -| `serverLabel` | *string* | :heavy_check_mark: | N/A | | -| `type` | [models.McpCallItemType](../models/mcpcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | | +| `error` | *models.McpToolCallError* | ➖ | Error from an MCP tool call, either a plain message or a structured error | \{
"code": 503,
"message": "Service Unavailable",
"type": "http_error"
} | +| `id` | *string* | ✅ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `output` | *string* | ➖ | N/A | | +| `serverLabel` | *string* | ✅ | N/A | | +| `type` | [models.McpCallItemType](../models/mcpcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/mcphttperror.mdx b/docs/models/mcphttperror.mdx index ad6f761fc..bd90dcbf6 100644 --- a/docs/models/mcphttperror.mdx +++ b/docs/models/mcphttperror.mdx @@ -20,6 +20,6 @@ let value: McpHttpError = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.McpHttpErrorType](../models/mcphttperrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `type` | [models.McpHttpErrorType](../models/mcphttperrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/mcplisttoolsitem.mdx b/docs/models/mcplisttoolsitem.mdx index d4f41f75a..3aaae46f4 100644 --- a/docs/models/mcplisttoolsitem.mdx +++ b/docs/models/mcplisttoolsitem.mdx @@ -33,8 +33,8 @@ let value: McpListToolsItem = { | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `error` | *string* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `tools` | [models.McpListToolsItemTool](../models/mcplisttoolsitemtool.mdx)[] | :heavy_check_mark: | N/A | -| `type` | [models.McpListToolsItemType](../models/mcplisttoolsitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `error` | *string* | ➖ | N/A | +| `id` | *string* | ✅ | N/A | +| `serverLabel` | *string* | ✅ | N/A | +| `tools` | [models.McpListToolsItemTool](../models/mcplisttoolsitemtool.mdx)[] | ✅ | N/A | +| `type` | [models.McpListToolsItemType](../models/mcplisttoolsitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/mcplisttoolsitemtool.mdx b/docs/models/mcplisttoolsitemtool.mdx index d20239994..cb091bb31 100644 --- a/docs/models/mcplisttoolsitemtool.mdx +++ b/docs/models/mcplisttoolsitemtool.mdx @@ -17,7 +17,7 @@ let value: McpListToolsItemTool = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `annotations` | *any* | :heavy_minus_sign: | N/A | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `inputSchema` | Record\ | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `annotations` | *any* | ➖ | N/A | +| `description` | *string* | ➖ | N/A | +| `inputSchema` | Record\ | ✅ | N/A | +| `name` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/mcpprotocolerror.mdx b/docs/models/mcpprotocolerror.mdx index 50e8e7e52..077a88c72 100644 --- a/docs/models/mcpprotocolerror.mdx +++ b/docs/models/mcpprotocolerror.mdx @@ -20,6 +20,6 @@ let value: McpProtocolError = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.McpProtocolErrorType](../models/mcpprotocolerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `type` | [models.McpProtocolErrorType](../models/mcpprotocolerrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/mcpservertool.mdx b/docs/models/mcpservertool.mdx index e7b401c6b..ba10b5eed 100644 --- a/docs/models/mcpservertool.mdx +++ b/docs/models/mcpservertool.mdx @@ -19,12 +19,12 @@ let value: McpServerTool = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `allowedTools` | *models.AllowedToolsUnion* | :heavy_minus_sign: | N/A | -| `authorization` | *string* | :heavy_minus_sign: | N/A | -| `connectorId` | [models.ConnectorId](../models/connectorid.mdx) | :heavy_minus_sign: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | N/A | -| `requireApproval` | *models.RequireApprovalUnion* | :heavy_minus_sign: | N/A | -| `serverDescription` | *string* | :heavy_minus_sign: | N/A | -| `serverLabel` | *string* | :heavy_check_mark: | N/A | -| `serverUrl` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.McpServerToolType](../models/mcpservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `allowedTools` | *models.AllowedToolsUnion* | ➖ | N/A | +| `authorization` | *string* | ➖ | N/A | +| `connectorId` | [models.ConnectorId](../models/connectorid.mdx) | ➖ | N/A | +| `headers` | Record\ | ➖ | N/A | +| `requireApproval` | *models.RequireApprovalUnion* | ➖ | N/A | +| `serverDescription` | *string* | ➖ | N/A | +| `serverLabel` | *string* | ✅ | N/A | +| `serverUrl` | *string* | ➖ | N/A | +| `type` | [models.McpServerToolType](../models/mcpservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/mcptoolexecutionerror.mdx b/docs/models/mcptoolexecutionerror.mdx index d0ccc899f..65af91904 100644 --- a/docs/models/mcptoolexecutionerror.mdx +++ b/docs/models/mcptoolexecutionerror.mdx @@ -18,5 +18,5 @@ let value: McpToolExecutionError = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `content` | *any* | :heavy_minus_sign: | N/A | -| `type` | [models.McpToolExecutionErrorType](../models/mcptoolexecutionerrortype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *any* | ➖ | N/A | +| `type` | [models.McpToolExecutionErrorType](../models/mcptoolexecutionerrortype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/memberassignment.mdx b/docs/models/memberassignment.mdx index 199cac772..4b3788d0a 100644 --- a/docs/models/memberassignment.mdx +++ b/docs/models/memberassignment.mdx @@ -21,9 +21,9 @@ let value: MemberAssignment = { | Field | Type | Required | Description | Example | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `assignedBy` | *string* | :heavy_check_mark: | User ID of who made the assignment | user_abc123 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | -| `guardrailId` | *string* | :heavy_check_mark: | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | -| `organizationId` | *string* | :heavy_check_mark: | Organization ID | org_xyz789 | -| `userId` | *string* | :heavy_check_mark: | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file +| `assignedBy` | *string* | ✅ | User ID of who made the assignment | user_abc123 | +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the assignment was created | 2025-08-24T10:30:00Z | +| `guardrailId` | *string* | ✅ | ID of the guardrail | 550e8400-e29b-41d4-a716-446655440001 | +| `id` | *string* | ✅ | Unique identifier for the assignment | 550e8400-e29b-41d4-a716-446655440000 | +| `organizationId` | *string* | ✅ | Organization ID | org_xyz789 | +| `userId` | *string* | ✅ | Clerk user ID of the assigned member | user_abc123 | \ No newline at end of file diff --git a/docs/models/message.mdx b/docs/models/message.mdx index 8da1c6b02..9c45bec26 100644 --- a/docs/models/message.mdx +++ b/docs/models/message.mdx @@ -18,11 +18,11 @@ let value: Message = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `annotations` | *models.Annotation*[] | :heavy_minus_sign: | N/A | -| `content` | *string* | :heavy_check_mark: | N/A | -| `images` | [models.Image](../models/image.mdx)[] | :heavy_minus_sign: | N/A | -| `reasoning` | *string* | :heavy_minus_sign: | N/A | -| `reasoningDetails` | *models.ReasoningDetail*[] | :heavy_minus_sign: | N/A | -| `refusal` | *string* | :heavy_check_mark: | N/A | -| `role` | [models.ChoiceRole](../models/choicerole.mdx) | :heavy_check_mark: | N/A | -| `toolCalls` | [models.ToolCall](../models/toolcall.mdx)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `annotations` | *models.Annotation*[] | ➖ | N/A | +| `content` | *string* | ✅ | N/A | +| `images` | [models.Image](../models/image.mdx)[] | ➖ | N/A | +| `reasoning` | *string* | ➖ | N/A | +| `reasoningDetails` | *models.ReasoningDetail*[] | ➖ | N/A | +| `refusal` | *string* | ✅ | N/A | +| `role` | [models.ChoiceRole](../models/choicerole.mdx) | ✅ | N/A | +| `toolCalls` | [models.ToolCall](../models/toolcall.mdx)[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/messagesadvisortoolresultblock.mdx b/docs/models/messagesadvisortoolresultblock.mdx index c6bba68b0..237a7793d 100644 --- a/docs/models/messagesadvisortoolresultblock.mdx +++ b/docs/models/messagesadvisortoolresultblock.mdx @@ -23,6 +23,6 @@ let value: MessagesAdvisorToolResultBlock = { | Field | Type | Required | Description | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `content` | Record\ | :heavy_check_mark: | N/A | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"advisor_tool_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | Record\ | ✅ | N/A | +| `toolUseId` | *string* | ✅ | N/A | +| `type` | *"advisor_tool_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagesbashtoolresultblock.mdx b/docs/models/messagesbashtoolresultblock.mdx index e5306a65d..af0f00540 100644 --- a/docs/models/messagesbashtoolresultblock.mdx +++ b/docs/models/messagesbashtoolresultblock.mdx @@ -25,8 +25,8 @@ let value: MessagesBashToolResultBlock = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `content` | Record\ | :heavy_check_mark: | N/A | -| `files` | [models.MessagesBashToolResultBlockFile](../models/messagesbashtoolresultblockfile.mdx)[] | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"openrouter_bash_tool_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `content` | Record\ | ✅ | N/A | +| `files` | [models.MessagesBashToolResultBlockFile](../models/messagesbashtoolresultblockfile.mdx)[] | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `toolUseId` | *string* | ✅ | N/A | +| `type` | *"openrouter_bash_tool_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagesbashtoolresultblockfile.mdx b/docs/models/messagesbashtoolresultblockfile.mdx index f9e4479d2..090b8efa1 100644 --- a/docs/models/messagesbashtoolresultblockfile.mdx +++ b/docs/models/messagesbashtoolresultblockfile.mdx @@ -21,9 +21,9 @@ let value: MessagesBashToolResultBlockFile = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_check_mark: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.MessagesBashToolResultBlockTypeContainerFileCitation](../models/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ✅ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `type` | [models.MessagesBashToolResultBlockTypeContainerFileCitation](../models/messagesbashtoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagesfallbackparam.mdx b/docs/models/messagesfallbackparam.mdx index 3e2f2a7e4..fdf9bf876 100644 --- a/docs/models/messagesfallbackparam.mdx +++ b/docs/models/messagesfallbackparam.mdx @@ -18,5 +18,5 @@ let value: MessagesFallbackParam = { | Field | Type | Required | Description | Example | | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file +| `model` | *string* | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"model": "claude-opus-4-8"
} | \ No newline at end of file diff --git a/docs/models/messagesmessageparam.mdx b/docs/models/messagesmessageparam.mdx index e66045109..22d53fc6d 100644 --- a/docs/models/messagesmessageparam.mdx +++ b/docs/models/messagesmessageparam.mdx @@ -19,7 +19,7 @@ let value: MessagesMessageParam = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `clearAt` | [models.AnthropicSystemClearAt](../models/anthropicsystemclearat.mdx) | :heavy_minus_sign: | N/A | next_user_message | -| `content` | *models.MessagesMessageParamContentUnion5* | :heavy_check_mark: | N/A | | -| `outputConfig` | [models.AnthropicMessageOutputConfig](../models/anthropicmessageoutputconfig.mdx) | :heavy_minus_sign: | N/A | \{
"effort": "low"
} | -| `role` | [models.MessagesMessageParamRole](../models/messagesmessageparamrole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `clearAt` | [models.AnthropicSystemClearAt](../models/anthropicsystemclearat.mdx) | ➖ | N/A | next_user_message | +| `content` | *models.MessagesMessageParamContentUnion5* | ✅ | N/A | | +| `outputConfig` | [models.AnthropicMessageOutputConfig](../models/anthropicmessageoutputconfig.mdx) | ➖ | N/A | \{
"effort": "low"
} | +| `role` | [models.MessagesMessageParamRole](../models/messagesmessageparamrole.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/messagesoutputconfig.mdx b/docs/models/messagesoutputconfig.mdx index 14573c947..b79f8de24 100644 --- a/docs/models/messagesoutputconfig.mdx +++ b/docs/models/messagesoutputconfig.mdx @@ -16,6 +16,6 @@ let value: MessagesOutputConfig = {}; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `effort` | [models.MessagesOutputConfigEffort](../models/messagesoutputconfigeffort.mdx) | :heavy_minus_sign: | How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. | medium | -| `format` | [models.MessagesOutputConfigFormat](../models/messagesoutputconfigformat.mdx) | :heavy_minus_sign: | A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). | | -| `taskBudget` | [models.TaskBudget](../models/taskbudget.mdx) | :heavy_minus_sign: | Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap. | \{
"total": 400000,
"type": "tokens"
} | \ No newline at end of file +| `effort` | [models.MessagesOutputConfigEffort](../models/messagesoutputconfigeffort.mdx) | ➖ | How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer. Valid values are `low`, `medium`, `high`, `xhigh`, or `max`. | medium | +| `format` | [models.MessagesOutputConfigFormat](../models/messagesoutputconfigformat.mdx) | ➖ | A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs). | | +| `taskBudget` | [models.TaskBudget](../models/taskbudget.mdx) | ➖ | Task budget for an agentic turn. The model sees a countdown of remaining tokens and uses it to prioritize work and wind down gracefully. Advisory — does not enforce a hard cap. | \{
"total": 400000,
"type": "tokens"
} | \ No newline at end of file diff --git a/docs/models/messagesoutputconfigformat.mdx b/docs/models/messagesoutputconfigformat.mdx index 367dfbc74..bb9d00a8c 100644 --- a/docs/models/messagesoutputconfigformat.mdx +++ b/docs/models/messagesoutputconfigformat.mdx @@ -19,5 +19,5 @@ let value: MessagesOutputConfigFormat = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `schema` | Record\ | :heavy_check_mark: | N/A | -| `type` | [models.MessagesOutputConfigTypeJSONSchema](../models/messagesoutputconfigtypejsonschema.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `schema` | Record\ | ✅ | N/A | +| `type` | [models.MessagesOutputConfigTypeJSONSchema](../models/messagesoutputconfigtypejsonschema.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagesrequest.mdx b/docs/models/messagesrequest.mdx index e077ebbd0..c18f411ae 100644 --- a/docs/models/messagesrequest.mdx +++ b/docs/models/messagesrequest.mdx @@ -24,30 +24,30 @@ let value: MessagesRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `contextManagement` | [models.ContextManagement](../models/contextmanagement.mdx) | :heavy_minus_sign: | N/A | | -| `fallbacks` | [models.MessagesFallbackParam](../models/messagesfallbackparam.mdx)[] | :heavy_minus_sign: | Fallback models to try if the primary model fails or refuses, in order. Handled by OpenRouter multi-model routing rather than Anthropic server-side fallbacks; cannot be combined with `models`. Each entry accepts only `model`. Maximum of 3 entries. | [
\{
"model": "claude-opus-4-8"
}
] | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | | -| `messages` | [models.MessagesMessageParam](../models/messagesmessageparam.mdx)[] | :heavy_check_mark: | N/A | | -| `metadata` | [models.MessagesRequestMetadata](../models/messagesrequestmetadata.mdx) | :heavy_minus_sign: | N/A | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `models` | *string*[] | :heavy_minus_sign: | N/A | | -| `outputConfig` | [models.MessagesOutputConfig](../models/messagesoutputconfig.mdx) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | -| `plugins` | *models.MessagesRequestPlugin*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `provider` | [models.ProviderPreferences](../models/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `safeguards` | [models.AnthropicSafeguard](../models/anthropicsafeguard.mdx)[] | :heavy_minus_sign: | N/A | | -| `serviceTier` | *string* | :heavy_minus_sign: | N/A | | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `speed` | [models.Speed](../models/speed.mdx) | :heavy_minus_sign: | N/A | fast | -| `stopSequences` | *string*[] | :heavy_minus_sign: | N/A | | -| `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `system` | *models.System* | :heavy_minus_sign: | N/A | | -| `temperature` | *number* | :heavy_minus_sign: | N/A | | -| `thinking` | *models.Thinking* | :heavy_minus_sign: | N/A | | -| `toolChoice` | *models.ToolChoice* | :heavy_minus_sign: | N/A | | -| `tools` | *models.MessagesRequestToolUnion*[] | :heavy_minus_sign: | N/A | | -| `topK` | *number* | :heavy_minus_sign: | N/A | | -| `topP` | *number* | :heavy_minus_sign: | N/A | | -| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `user` | *string* | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `contextManagement` | [models.ContextManagement](../models/contextmanagement.mdx) | ➖ | N/A | | +| `fallbacks` | [models.MessagesFallbackParam](../models/messagesfallbackparam.mdx)[] | ➖ | Fallback models to try if the primary model fails or refuses, in order. Handled by OpenRouter multi-model routing rather than Anthropic server-side fallbacks; cannot be combined with `models`. Each entry accepts only `model`. Maximum of 3 entries. | [
\{
"model": "claude-opus-4-8"
}
] | +| `maxTokens` | *number* | ➖ | N/A | | +| `messages` | [models.MessagesMessageParam](../models/messagesmessageparam.mdx)[] | ✅ | N/A | | +| `metadata` | [models.MessagesRequestMetadata](../models/messagesrequestmetadata.mdx) | ➖ | N/A | | +| `model` | *string* | ✅ | N/A | | +| `models` | *string*[] | ➖ | N/A | | +| `outputConfig` | [models.MessagesOutputConfig](../models/messagesoutputconfig.mdx) | ➖ | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | +| `plugins` | *models.MessagesRequestPlugin*[] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `provider` | [models.ProviderPreferences](../models/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `safeguards` | [models.AnthropicSafeguard](../models/anthropicsafeguard.mdx)[] | ➖ | N/A | | +| `serviceTier` | *string* | ➖ | N/A | | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | +| `speed` | [models.Speed](../models/speed.mdx) | ➖ | N/A | fast | +| `stopSequences` | *string*[] | ➖ | N/A | | +| `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | +| `stream` | *boolean* | ➖ | N/A | | +| `system` | *models.System* | ➖ | N/A | | +| `temperature` | *number* | ➖ | N/A | | +| `thinking` | *models.Thinking* | ➖ | N/A | | +| `toolChoice` | *models.ToolChoice* | ➖ | N/A | | +| `tools` | *models.MessagesRequestToolUnion*[] | ➖ | N/A | | +| `topK` | *number* | ➖ | N/A | | +| `topP` | *number* | ➖ | N/A | | +| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `user` | *string* | ➖ | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file diff --git a/docs/models/messagesrequestmetadata.mdx b/docs/models/messagesrequestmetadata.mdx index e951c05c3..fc271b495 100644 --- a/docs/models/messagesrequestmetadata.mdx +++ b/docs/models/messagesrequestmetadata.mdx @@ -14,4 +14,4 @@ let value: MessagesRequestMetadata = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `userId` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `userId` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/messagesrequesttool.mdx b/docs/models/messagesrequesttool.mdx index 1252dd9c6..e5a920e7a 100644 --- a/docs/models/messagesrequesttool.mdx +++ b/docs/models/messagesrequesttool.mdx @@ -16,5 +16,5 @@ let value: MessagesRequestTool = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *string* | ✅ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/messagessearchmodelsservertool.mdx b/docs/models/messagessearchmodelsservertool.mdx index aae62c6e1..29f09f842 100644 --- a/docs/models/messagessearchmodelsservertool.mdx +++ b/docs/models/messagessearchmodelsservertool.mdx @@ -18,5 +18,5 @@ let value: MessagesSearchModelsServerTool = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [models.MessagesSearchModelsServerToolType](../models/messagessearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [models.MessagesSearchModelsServerToolType](../models/messagessearchmodelsservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/messagesshelltoolresultblock.mdx b/docs/models/messagesshelltoolresultblock.mdx index 7ac7b7809..6c9287239 100644 --- a/docs/models/messagesshelltoolresultblock.mdx +++ b/docs/models/messagesshelltoolresultblock.mdx @@ -31,8 +31,8 @@ let value: MessagesShellToolResultBlock = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `content` | Record\ | :heavy_check_mark: | N/A | -| `files` | [models.MessagesShellToolResultBlockFile](../models/messagesshelltoolresultblockfile.mdx)[] | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"openrouter_shell_tool_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `content` | Record\ | ✅ | N/A | +| `files` | [models.MessagesShellToolResultBlockFile](../models/messagesshelltoolresultblockfile.mdx)[] | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `toolUseId` | *string* | ✅ | N/A | +| `type` | *"openrouter_shell_tool_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagesshelltoolresultblockfile.mdx b/docs/models/messagesshelltoolresultblockfile.mdx index 2b5abeb79..058b8e4f8 100644 --- a/docs/models/messagesshelltoolresultblockfile.mdx +++ b/docs/models/messagesshelltoolresultblockfile.mdx @@ -21,9 +21,9 @@ let value: MessagesShellToolResultBlockFile = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_check_mark: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.MessagesShellToolResultBlockTypeContainerFileCitation](../models/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ✅ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `type` | [models.MessagesShellToolResultBlockTypeContainerFileCitation](../models/messagesshelltoolresultblocktypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagestooladditionblock.mdx b/docs/models/messagestooladditionblock.mdx index cc21ce65c..6620ba8f6 100644 --- a/docs/models/messagestooladditionblock.mdx +++ b/docs/models/messagestooladditionblock.mdx @@ -22,6 +22,6 @@ let value: MessagesToolAdditionBlock = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `tool` | *models.MessagesToolAdditionBlockToolUnion* | :heavy_check_mark: | N/A | | -| `type` | *"tool_addition"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `tool` | *models.MessagesToolAdditionBlockToolUnion* | ✅ | N/A | | +| `type` | *"tool_addition"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/messagestooladditionblocktoolmcptoolreference.mdx b/docs/models/messagestooladditionblocktoolmcptoolreference.mdx index e4de95661..15bfbc245 100644 --- a/docs/models/messagestooladditionblocktoolmcptoolreference.mdx +++ b/docs/models/messagestooladditionblocktoolmcptoolreference.mdx @@ -18,6 +18,6 @@ let value: MessagesToolAdditionBlockToolMcpToolReference = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `serverName` | *string* | :heavy_check_mark: | N/A | -| `type` | *"mcp_tool_reference"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *string* | ✅ | N/A | +| `serverName` | *string* | ✅ | N/A | +| `type` | *"mcp_tool_reference"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagestooladditionblocktoolmcptoolsetreference.mdx b/docs/models/messagestooladditionblocktoolmcptoolsetreference.mdx index f8662ab78..0008be4d5 100644 --- a/docs/models/messagestooladditionblocktoolmcptoolsetreference.mdx +++ b/docs/models/messagestooladditionblocktoolmcptoolsetreference.mdx @@ -17,5 +17,5 @@ let value: MessagesToolAdditionBlockToolMcpToolsetReference = { | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `serverName` | *string* | :heavy_check_mark: | N/A | -| `type` | *"mcp_toolset_reference"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `serverName` | *string* | ✅ | N/A | +| `type` | *"mcp_toolset_reference"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagestooladditionblocktooltoolreference.mdx b/docs/models/messagestooladditionblocktooltoolreference.mdx index 58c5acb16..706a7d357 100644 --- a/docs/models/messagestooladditionblocktooltoolreference.mdx +++ b/docs/models/messagestooladditionblocktooltoolreference.mdx @@ -17,5 +17,5 @@ let value: MessagesToolAdditionBlockToolToolReference = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | -| `type` | *"tool_reference"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *string* | ✅ | N/A | +| `type` | *"tool_reference"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagestoolremovalblock.mdx b/docs/models/messagestoolremovalblock.mdx index 64e9bbc89..8ea165d31 100644 --- a/docs/models/messagestoolremovalblock.mdx +++ b/docs/models/messagestoolremovalblock.mdx @@ -22,6 +22,6 @@ let value: MessagesToolRemovalBlock = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `tool` | *models.MessagesToolRemovalBlockToolUnion* | :heavy_check_mark: | N/A | | -| `type` | *"tool_removal"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `tool` | *models.MessagesToolRemovalBlockToolUnion* | ✅ | N/A | | +| `type` | *"tool_removal"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/messagestoolremovalblocktoolmcptoolreference.mdx b/docs/models/messagestoolremovalblocktoolmcptoolreference.mdx index c3e2ef682..5939e6d4c 100644 --- a/docs/models/messagestoolremovalblocktoolmcptoolreference.mdx +++ b/docs/models/messagestoolremovalblocktoolmcptoolreference.mdx @@ -18,6 +18,6 @@ let value: MessagesToolRemovalBlockToolMcpToolReference = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `serverName` | *string* | :heavy_check_mark: | N/A | -| `type` | *"mcp_tool_reference"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *string* | ✅ | N/A | +| `serverName` | *string* | ✅ | N/A | +| `type` | *"mcp_tool_reference"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagestoolremovalblocktoolmcptoolsetreference.mdx b/docs/models/messagestoolremovalblocktoolmcptoolsetreference.mdx index 2c630559f..35a62c1de 100644 --- a/docs/models/messagestoolremovalblocktoolmcptoolsetreference.mdx +++ b/docs/models/messagestoolremovalblocktoolmcptoolsetreference.mdx @@ -17,5 +17,5 @@ let value: MessagesToolRemovalBlockToolMcpToolsetReference = { | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `serverName` | *string* | :heavy_check_mark: | N/A | -| `type` | *"mcp_toolset_reference"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `serverName` | *string* | ✅ | N/A | +| `type` | *"mcp_toolset_reference"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/messagestoolremovalblocktooltoolreference.mdx b/docs/models/messagestoolremovalblocktooltoolreference.mdx index ad62cb341..dafbfbe89 100644 --- a/docs/models/messagestoolremovalblocktooltoolreference.mdx +++ b/docs/models/messagestoolremovalblocktooltoolreference.mdx @@ -17,5 +17,5 @@ let value: MessagesToolRemovalBlockToolToolReference = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `name` | *string* | :heavy_check_mark: | N/A | -| `type` | *"tool_reference"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *string* | ✅ | N/A | +| `type` | *"tool_reference"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/mismatchbehavior.mdx b/docs/models/mismatchbehavior.mdx index 6b379caa1..e9f740238 100644 --- a/docs/models/mismatchbehavior.mdx +++ b/docs/models/mismatchbehavior.mdx @@ -4,7 +4,7 @@ title: "~~MismatchBehavior~~" Deprecated: legacy alias of prefix_mismatch_behavior. Send only one of the two. -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Example Usage diff --git a/docs/models/model.mdx b/docs/models/model.mdx index 45cc337c0..4deb0be1b 100644 --- a/docs/models/model.mdx +++ b/docs/models/model.mdx @@ -49,23 +49,23 @@ let value: Model = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aliasTarget` | [models.ModelAliasTarget](../models/modelaliastarget.mdx) | :heavy_minus_sign: | Concrete model targeted by this tilde-latest alias, when applicable | \{
"name": "Claude Sonnet 4.5",
"slug": "anthropic/claude-sonnet-4.5"
} | -| `architecture` | [models.ModelArchitecture](../models/modelarchitecture.mdx) | :heavy_check_mark: | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `benchmarks` | [models.ModelBenchmarks](../models/modelbenchmarks.mdx) | :heavy_minus_sign: | Third-party benchmark rankings for this model. Omitted when no benchmark data is available. | \{
"artificial_analysis": \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
},
"design_arena": [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
]
} | -| `canonicalSlug` | *string* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `contextLength` | *number* | :heavy_check_mark: | Maximum context length in tokens | 8192 | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `defaultParameters` | [models.DefaultParameters](../models/defaultparameters.mdx) | :heavy_check_mark: | Default parameters for this model | \{
"frequency_penalty": 0,
"presence_penalty": 0,
"repetition_penalty": 1,
"temperature": 0.7,
"top_k": 0,
"top_p": 0.9
} | -| `description` | *string* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `expirationDate` | *string* | :heavy_minus_sign: | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | -| `huggingFaceId` | *string* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `knowledgeCutoff` | *string* | :heavy_minus_sign: | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 | -| `links` | [models.ModelLinks](../models/modellinks.mdx) | :heavy_check_mark: | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | -| `name` | *string* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `perRequestLimits` | [models.PerRequestLimits](../models/perrequestlimits.mdx) | :heavy_check_mark: | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | -| `pricing` | [models.PublicPricing](../models/publicpricing.mdx) | :heavy_check_mark: | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | -| `reasoning` | [models.ModelReasoning](../models/modelreasoning.mdx) | :heavy_minus_sign: | Reasoning effort configuration. Omitted for non-reasoning models and dynamic router models. | \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
} | -| `supportedParameters` | [models.Parameter](../models/parameter.mdx)[] | :heavy_check_mark: | List of supported parameters for this model | | -| `supportedVoices` | *string*[] | :heavy_check_mark: | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | -| `topProvider` | [models.TopProviderInfo](../models/topproviderinfo.mdx) | :heavy_check_mark: | Information about the top provider for this model | \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
} | \ No newline at end of file +| `aliasTarget` | [models.ModelAliasTarget](../models/modelaliastarget.mdx) | ➖ | Concrete model targeted by this tilde-latest alias, when applicable | \{
"name": "Claude Sonnet 4.5",
"slug": "anthropic/claude-sonnet-4.5"
} | +| `architecture` | [models.ModelArchitecture](../models/modelarchitecture.mdx) | ✅ | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `benchmarks` | [models.ModelBenchmarks](../models/modelbenchmarks.mdx) | ➖ | Third-party benchmark rankings for this model. Omitted when no benchmark data is available. | \{
"artificial_analysis": \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
},
"design_arena": [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
]
} | +| `canonicalSlug` | *string* | ✅ | Canonical slug for the model | openai/gpt-4 | +| `contextLength` | *number* | ✅ | Maximum context length in tokens | 8192 | +| `created` | *number* | ✅ | Unix timestamp of when the model was created | 1692901234 | +| `defaultParameters` | [models.DefaultParameters](../models/defaultparameters.mdx) | ✅ | Default parameters for this model | \{
"frequency_penalty": 0,
"presence_penalty": 0,
"repetition_penalty": 1,
"temperature": 0.7,
"top_k": 0,
"top_p": 0.9
} | +| `description` | *string* | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `expirationDate` | *string* | ➖ | The date after which the model may be removed. ISO 8601 date string (YYYY-MM-DD) or null if no expiration. | 2025-06-01 | +| `huggingFaceId` | *string* | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `id` | *string* | ✅ | Unique identifier for the model | openai/gpt-4 | +| `knowledgeCutoff` | *string* | ➖ | The date up to which the model was trained on data. ISO 8601 date string (YYYY-MM-DD) or null if unknown. | 2024-10-01 | +| `links` | [models.ModelLinks](../models/modellinks.mdx) | ✅ | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | +| `name` | *string* | ✅ | Display name of the model | GPT-4 | +| `perRequestLimits` | [models.PerRequestLimits](../models/perrequestlimits.mdx) | ✅ | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | +| `pricing` | [models.PublicPricing](../models/publicpricing.mdx) | ✅ | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | +| `reasoning` | [models.ModelReasoning](../models/modelreasoning.mdx) | ➖ | Reasoning effort configuration. Omitted for non-reasoning models and dynamic router models. | \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
} | +| `supportedParameters` | [models.Parameter](../models/parameter.mdx)[] | ✅ | List of supported parameters for this model | | +| `supportedVoices` | *string*[] | ✅ | List of supported voice identifiers for TTS models. Null for non-TTS models. | null | +| `topProvider` | [models.TopProviderInfo](../models/topproviderinfo.mdx) | ✅ | Information about the top provider for this model | \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
} | \ No newline at end of file diff --git a/docs/models/modelaliastarget.mdx b/docs/models/modelaliastarget.mdx index 25f3e92ba..39f95950a 100644 --- a/docs/models/modelaliastarget.mdx +++ b/docs/models/modelaliastarget.mdx @@ -19,5 +19,5 @@ let value: ModelAliasTarget = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | Human-readable name of the concrete model targeted by this alias | -| `slug` | *string* | :heavy_check_mark: | Routable model ID of the concrete target, matching that model row's id | \ No newline at end of file +| `name` | *string* | ✅ | Human-readable name of the concrete model targeted by this alias | +| `slug` | *string* | ✅ | Routable model ID of the concrete target, matching that model row's id | \ No newline at end of file diff --git a/docs/models/modelarchitecture.mdx b/docs/models/modelarchitecture.mdx index e7317099a..8335a740f 100644 --- a/docs/models/modelarchitecture.mdx +++ b/docs/models/modelarchitecture.mdx @@ -24,8 +24,8 @@ let value: ModelArchitecture = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `inputModalities` | [models.InputModality](../models/inputmodality.mdx)[] | :heavy_check_mark: | Supported input modalities | | -| `instructType` | [models.InstructType](../models/instructtype.mdx) | :heavy_minus_sign: | Instruction format type | chatml | -| `modality` | *string* | :heavy_check_mark: | Primary modality of the model | text->text | -| `outputModalities` | [models.OutputModality](../models/outputmodality.mdx)[] | :heavy_check_mark: | Supported output modalities | | -| `tokenizer` | [models.ModelGroup](../models/modelgroup.mdx) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file +| `inputModalities` | [models.InputModality](../models/inputmodality.mdx)[] | ✅ | Supported input modalities | | +| `instructType` | [models.InstructType](../models/instructtype.mdx) | ➖ | Instruction format type | chatml | +| `modality` | *string* | ✅ | Primary modality of the model | text->text | +| `outputModalities` | [models.OutputModality](../models/outputmodality.mdx)[] | ✅ | Supported output modalities | | +| `tokenizer` | [models.ModelGroup](../models/modelgroup.mdx) | ➖ | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/docs/models/modelbenchmarks.mdx b/docs/models/modelbenchmarks.mdx index 89fbaf443..aa454f89f 100644 --- a/docs/models/modelbenchmarks.mdx +++ b/docs/models/modelbenchmarks.mdx @@ -26,5 +26,5 @@ let value: ModelBenchmarks = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `artificialAnalysis` | [models.AABenchmarkEntry](../models/aabenchmarkentry.mdx) | :heavy_minus_sign: | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | -| `designArena` | [models.DABenchmarkEntry](../models/dabenchmarkentry.mdx)[] | :heavy_check_mark: | Design Arena ELO rankings across arena+category pairs. | [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
] | \ No newline at end of file +| `artificialAnalysis` | [models.AABenchmarkEntry](../models/aabenchmarkentry.mdx) | ➖ | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | +| `designArena` | [models.DABenchmarkEntry](../models/dabenchmarkentry.mdx)[] | ✅ | Design Arena ELO rankings across arena+category pairs. | [
\{
"arena": "models",
"category": "website",
"elo": 1385.2,
"rank": 5,
"win_rate": 62.5
}
] | \ No newline at end of file diff --git a/docs/models/modellinks.mdx b/docs/models/modellinks.mdx index 923e1dbb0..d0bd59e50 100644 --- a/docs/models/modellinks.mdx +++ b/docs/models/modellinks.mdx @@ -18,4 +18,4 @@ let value: ModelLinks = { | Field | Type | Required | Description | Example | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `details` | *string* | :heavy_check_mark: | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file +| `details` | *string* | ✅ | URL for the model details/endpoints API | /api/v1/models/openai/gpt-5.4/endpoints | \ No newline at end of file diff --git a/docs/models/modelreasoning.mdx b/docs/models/modelreasoning.mdx index 2cd23e651..79dc033d0 100644 --- a/docs/models/modelreasoning.mdx +++ b/docs/models/modelreasoning.mdx @@ -18,8 +18,8 @@ let value: ModelReasoning = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `defaultEffort` | [models.DefaultEffort](../models/defaulteffort.mdx) | :heavy_minus_sign: | N/A | medium | -| `defaultEnabled` | *boolean* | :heavy_minus_sign: | Default reasoning enabled state when the client does not set `reasoning.enabled`. | | -| `mandatory` | *boolean* | :heavy_check_mark: | When true, reasoning cannot be disabled and effort "none" is rejected. | | -| `supportedEfforts` | [models.ReasoningEffort](../models/reasoningeffort.mdx)[] | :heavy_minus_sign: | Allowed reasoning effort values for this model, in descending effort order (highest first). Null means no allowlist — all gateway effort values are accepted. | | -| `supportsMaxTokens` | *boolean* | :heavy_minus_sign: | Present and `true` when the model accepts `reasoning.max_tokens` in requests (Anthropic-style) instead of or in addition to `reasoning.effort`. Omitted otherwise. | | \ No newline at end of file +| `defaultEffort` | [models.DefaultEffort](../models/defaulteffort.mdx) | ➖ | N/A | medium | +| `defaultEnabled` | *boolean* | ➖ | Default reasoning enabled state when the client does not set `reasoning.enabled`. | | +| `mandatory` | *boolean* | ✅ | When true, reasoning cannot be disabled and effort "none" is rejected. | | +| `supportedEfforts` | [models.ReasoningEffort](../models/reasoningeffort.mdx)[] | ➖ | Allowed reasoning effort values for this model, in descending effort order (highest first). Null means no allowlist — all gateway effort values are accepted. | | +| `supportsMaxTokens` | *boolean* | ➖ | Present and `true` when the model accepts `reasoning.max_tokens` in requests (Anthropic-style) instead of or in addition to `reasoning.effort`. Omitted otherwise. | | \ No newline at end of file diff --git a/docs/models/modelresponse.mdx b/docs/models/modelresponse.mdx index 0ee024a40..1119fb24c 100644 --- a/docs/models/modelresponse.mdx +++ b/docs/models/modelresponse.mdx @@ -51,4 +51,4 @@ let value: ModelResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Model](../models/model.mdx) | :heavy_check_mark: | Information about an AI model available on OpenRouter | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"reasoning": \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
} | \ No newline at end of file +| `data` | [models.Model](../models/model.mdx) | ✅ | Information about an AI model available on OpenRouter | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"reasoning": \{
"default_effort": "medium",
"default_enabled": true,
"mandatory": false,
"supported_efforts": [
"high",
"medium",
"low",
"minimal"
]
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
} | \ No newline at end of file diff --git a/docs/models/modelscountresponse.mdx b/docs/models/modelscountresponse.mdx index eb143205e..93ba40b5a 100644 --- a/docs/models/modelscountresponse.mdx +++ b/docs/models/modelscountresponse.mdx @@ -20,4 +20,4 @@ let value: ModelsCountResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [models.ModelsCountResponseData](../models/modelscountresponsedata.mdx) | :heavy_check_mark: | Model count data | \{
"count": 150
} | \ No newline at end of file +| `data` | [models.ModelsCountResponseData](../models/modelscountresponsedata.mdx) | ✅ | Model count data | \{
"count": 150
} | \ No newline at end of file diff --git a/docs/models/modelscountresponsedata.mdx b/docs/models/modelscountresponsedata.mdx index e8415a559..0d1a7057a 100644 --- a/docs/models/modelscountresponsedata.mdx +++ b/docs/models/modelscountresponsedata.mdx @@ -18,4 +18,4 @@ let value: ModelsCountResponseData = { | Field | Type | Required | Description | Example | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `count` | *number* | :heavy_check_mark: | Total number of available models | 150 | \ No newline at end of file +| `count` | *number* | ✅ | Total number of available models | 150 | \ No newline at end of file diff --git a/docs/models/modelslistresponse.mdx b/docs/models/modelslistresponse.mdx index 418f7f126..09d28e007 100644 --- a/docs/models/modelslistresponse.mdx +++ b/docs/models/modelslistresponse.mdx @@ -59,6 +59,6 @@ let value: ModelsListResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Model](../models/model.mdx)[] | :heavy_check_mark: | List of available models | [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
] | -| `links` | [models.ModelsListResponseLinks](../models/modelslistresponselinks.mdx) | :heavy_check_mark: | Pagination links | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of models matching the query | 150 | \ No newline at end of file +| `data` | [models.Model](../models/model.mdx)[] | ✅ | List of available models | [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
] | +| `links` | [models.ModelsListResponseLinks](../models/modelslistresponselinks.mdx) | ✅ | Pagination links | | +| `totalCount` | *number* | ✅ | Total number of models matching the query | 150 | \ No newline at end of file diff --git a/docs/models/modelslistresponselinks.mdx b/docs/models/modelslistresponselinks.mdx index 4bf366758..887bf4e80 100644 --- a/docs/models/modelslistresponselinks.mdx +++ b/docs/models/modelslistresponselinks.mdx @@ -18,4 +18,4 @@ let value: ModelsListResponseLinks = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `next` | *string* | :heavy_check_mark: | URL for the next page of results, or null if this is the last page | /api/v1/models?offset=500&limit=500 | \ No newline at end of file +| `next` | *string* | ✅ | URL for the next page of results, or null if this is the last page | /api/v1/models?offset=500&limit=500 | \ No newline at end of file diff --git a/docs/models/moderationplugin.mdx b/docs/models/moderationplugin.mdx index 7d06c5497..19a9be959 100644 --- a/docs/models/moderationplugin.mdx +++ b/docs/models/moderationplugin.mdx @@ -16,4 +16,4 @@ let value: ModerationPlugin = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `id` | *"moderation"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `id` | *"moderation"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/multimodalmedia.mdx b/docs/models/multimodalmedia.mdx index d742fdef7..4879441eb 100644 --- a/docs/models/multimodalmedia.mdx +++ b/docs/models/multimodalmedia.mdx @@ -16,5 +16,5 @@ let value: MultimodalMedia = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | -| `format` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `data` | *string* | ✅ | N/A | +| `format` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/namespacefunctiontool.mdx b/docs/models/namespacefunctiontool.mdx index 6ab730050..c62c93627 100644 --- a/docs/models/namespacefunctiontool.mdx +++ b/docs/models/namespacefunctiontool.mdx @@ -19,12 +19,12 @@ let value: NamespaceFunctionTool = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedCallers` | [models.AllowedCaller](../models/allowedcaller.mdx)[] | :heavy_minus_sign: | N/A | | -| `async` | *boolean* | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | -| `description` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `outputSchema` | Record\ | :heavy_minus_sign: | N/A | | -| `parameters` | Record\ | :heavy_minus_sign: | N/A | | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | | -| `type` | *"function"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowedCallers` | [models.AllowedCaller](../models/allowedcaller.mdx)[] | ➖ | N/A | | +| `async` | *boolean* | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `deferLoading` | *boolean* | ➖ | N/A | | +| `description` | *string* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `outputSchema` | Record\ | ➖ | N/A | | +| `parameters` | Record\ | ➖ | N/A | | +| `strict` | *boolean* | ➖ | N/A | | +| `type` | *"function"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/namespacetool.mdx b/docs/models/namespacetool.mdx index 0e67a080b..33c977a75 100644 --- a/docs/models/namespacetool.mdx +++ b/docs/models/namespacetool.mdx @@ -26,7 +26,7 @@ let value: NamespaceTool = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `description` | *string* | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `tools` | *models.NamespaceToolTool*[] | :heavy_check_mark: | N/A | -| `type` | [models.NamespaceToolType](../models/namespacetooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `description` | *string* | ✅ | N/A | +| `name` | *string* | ✅ | N/A | +| `tools` | *models.NamespaceToolTool*[] | ✅ | N/A | +| `type` | [models.NamespaceToolType](../models/namespacetooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/nativesupport.mdx b/docs/models/nativesupport.mdx index 67337e8c9..81f225fa2 100644 --- a/docs/models/nativesupport.mdx +++ b/docs/models/nativesupport.mdx @@ -28,6 +28,6 @@ let value: NativeSupport = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `endpointCount` | *number* | :heavy_check_mark: | N/A | 18 | -| `modelCount` | *number* | :heavy_check_mark: | N/A | 12 | -| `models` | [models.ServerToolNativeModel](../models/servertoolnativemodel.mdx)[] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `endpointCount` | *number* | ✅ | N/A | 18 | +| `modelCount` | *number* | ✅ | N/A | 12 | +| `models` | [models.ServerToolNativeModel](../models/servertoolnativemodel.mdx)[] | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/nativetools.mdx b/docs/models/nativetools.mdx index 3095ac946..f7de34342 100644 --- a/docs/models/nativetools.mdx +++ b/docs/models/nativetools.mdx @@ -16,4 +16,4 @@ let value: NativeTools = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` | *string* | :heavy_check_mark: | The provider tool type the request is translated to when this tool runs natively, e.g. `web_search_20260209` on Anthropic or `google_search` on Gemini. | \ No newline at end of file +| `type` | *string* | ✅ | The provider tool type the request is translated to when this tool runs natively, e.g. `web_search_20260209` on Anthropic or `google_search` on Gemini. | \ No newline at end of file diff --git a/docs/models/never.mdx b/docs/models/never.mdx index d79363088..942241ba2 100644 --- a/docs/models/never.mdx +++ b/docs/models/never.mdx @@ -14,4 +14,4 @@ let value: Never = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `toolNames` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `toolNames` | *string*[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/notfoundresponseerrordata.mdx b/docs/models/notfoundresponseerrordata.mdx index c46e36ece..662ab0027 100644 --- a/docs/models/notfoundresponseerrordata.mdx +++ b/docs/models/notfoundresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: NotFoundResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/oauthjwks.mdx b/docs/models/oauthjwks.mdx index f9e1e6e34..ff00f6c0d 100644 --- a/docs/models/oauthjwks.mdx +++ b/docs/models/oauthjwks.mdx @@ -28,4 +28,4 @@ let value: OAuthJwks = { | Field | Type | Required | Description | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `keys` | [models.Key](../models/key.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `keys` | [models.Key](../models/key.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilityarizedestination.mdx b/docs/models/observabilityarizedestination.mdx index 7dd3c6ff1..25b5ed975 100644 --- a/docs/models/observabilityarizedestination.mdx +++ b/docs/models/observabilityarizedestination.mdx @@ -38,19 +38,19 @@ let value: ObservabilityArizeDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityArizeDestinationConfig](../models/observabilityarizedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"arize"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityArizeDestinationConfig](../models/observabilityarizedestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"arize"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilityarizedestinationconfig.mdx b/docs/models/observabilityarizedestinationconfig.mdx index a90b80317..3fed9b828 100644 --- a/docs/models/observabilityarizedestinationconfig.mdx +++ b/docs/models/observabilityarizedestinationconfig.mdx @@ -18,8 +18,8 @@ let value: ObservabilityArizeDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `modelId` | *string* | :heavy_check_mark: | The name of the tracing project in Arize AX | -| `spaceKey` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `apiKey` | *string* | ✅ | N/A | +| `baseUrl` | *string* | ➖ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `modelId` | *string* | ✅ | The name of the tracing project in Arize AX | +| `spaceKey` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilitybraintrustdestination.mdx b/docs/models/observabilitybraintrustdestination.mdx index 111022ce0..3429b6162 100644 --- a/docs/models/observabilitybraintrustdestination.mdx +++ b/docs/models/observabilitybraintrustdestination.mdx @@ -37,19 +37,19 @@ let value: ObservabilityBraintrustDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityBraintrustDestinationConfig](../models/observabilitybraintrustdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"braintrust"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityBraintrustDestinationConfig](../models/observabilitybraintrustdestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"braintrust"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitybraintrustdestinationconfig.mdx b/docs/models/observabilitybraintrustdestinationconfig.mdx index 86cfbca98..ab82374f7 100644 --- a/docs/models/observabilitybraintrustdestinationconfig.mdx +++ b/docs/models/observabilitybraintrustdestinationconfig.mdx @@ -17,7 +17,7 @@ let value: ObservabilityBraintrustDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `projectId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `apiKey` | *string* | ✅ | N/A | +| `baseUrl` | *string* | ➖ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `projectId` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilityclickhousedestination.mdx b/docs/models/observabilityclickhousedestination.mdx index 9db1a2db2..d67acc472 100644 --- a/docs/models/observabilityclickhousedestination.mdx +++ b/docs/models/observabilityclickhousedestination.mdx @@ -38,19 +38,19 @@ let value: ObservabilityClickhouseDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityClickhouseDestinationConfig](../models/observabilityclickhousedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"clickhouse"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityClickhouseDestinationConfig](../models/observabilityclickhousedestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"clickhouse"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilityclickhousedestinationconfig.mdx b/docs/models/observabilityclickhousedestinationconfig.mdx index 2a268fc43..b78b78976 100644 --- a/docs/models/observabilityclickhousedestinationconfig.mdx +++ b/docs/models/observabilityclickhousedestinationconfig.mdx @@ -19,10 +19,10 @@ let value: ObservabilityClickhouseDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `database` | *string* | :heavy_check_mark: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `host` | *string* | :heavy_check_mark: | N/A | -| `password` | *string* | :heavy_check_mark: | N/A | -| `shouldIncludeCacheWriteTokens` | *boolean* | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `table` | *string* | :heavy_minus_sign: | N/A | -| `username` | *string* | :heavy_check_mark: | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file +| `database` | *string* | ✅ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `host` | *string* | ✅ | N/A | +| `password` | *string* | ✅ | N/A | +| `shouldIncludeCacheWriteTokens` | *boolean* | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `table` | *string* | ➖ | N/A | +| `username` | *string* | ✅ | If you have not set a specific username in ClickHouse, simply type in 'default' below. | \ No newline at end of file diff --git a/docs/models/observabilitydatadogdestination.mdx b/docs/models/observabilitydatadogdestination.mdx index bcfaf58e1..e33665e11 100644 --- a/docs/models/observabilitydatadogdestination.mdx +++ b/docs/models/observabilitydatadogdestination.mdx @@ -36,19 +36,19 @@ let value: ObservabilityDatadogDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityDatadogDestinationConfig](../models/observabilitydatadogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"datadog"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityDatadogDestinationConfig](../models/observabilitydatadogdestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"datadog"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitydatadogdestinationconfig.mdx b/docs/models/observabilitydatadogdestinationconfig.mdx index 0426a5e9f..8f99c372d 100644 --- a/docs/models/observabilitydatadogdestinationconfig.mdx +++ b/docs/models/observabilitydatadogdestinationconfig.mdx @@ -17,7 +17,7 @@ let value: ObservabilityDatadogDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | Datadog API key must have LLM Observability permissions. Create at: | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `mlApp` | *string* | :heavy_check_mark: | Name to identify your application in Datadog LLM Observability | -| `url` | *string* | :heavy_minus_sign: | Datadog API URL for your region (e.g., https://api.datadoghq.com, https://api.us3.datadoghq.com, https://api.us5.datadoghq.com, https://api.datadoghq.eu) | \ No newline at end of file +| `apiKey` | *string* | ✅ | Datadog API key must have LLM Observability permissions. Create at: | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `mlApp` | *string* | ✅ | Name to identify your application in Datadog LLM Observability | +| `url` | *string* | ➖ | Datadog API URL for your region (e.g., https://api.datadoghq.com, https://api.us3.datadoghq.com, https://api.us5.datadoghq.com, https://api.datadoghq.eu) | \ No newline at end of file diff --git a/docs/models/observabilityfilterrulegroup.mdx b/docs/models/observabilityfilterrulegroup.mdx index ceebfc7d8..4ffd9cbe3 100644 --- a/docs/models/observabilityfilterrulegroup.mdx +++ b/docs/models/observabilityfilterrulegroup.mdx @@ -21,5 +21,5 @@ let value: ObservabilityFilterRuleGroup = { | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `logic` | [models.Logic](../models/logic.mdx) | :heavy_minus_sign: | N/A | -| `rules` | [models.Rule](../models/rule.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `logic` | [models.Logic](../models/logic.mdx) | ➖ | N/A | +| `rules` | [models.Rule](../models/rule.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilityfilterrulesconfig.mdx b/docs/models/observabilityfilterrulesconfig.mdx index ae315f7ed..81b94bd21 100644 --- a/docs/models/observabilityfilterrulesconfig.mdx +++ b/docs/models/observabilityfilterrulesconfig.mdx @@ -27,5 +27,5 @@ let value: ObservabilityFilterRulesConfig = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | -| `groups` | [models.ObservabilityFilterRuleGroup](../models/observabilityfilterrulegroup.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `enabled` | *boolean* | ➖ | N/A | +| `groups` | [models.ObservabilityFilterRuleGroup](../models/observabilityfilterrulegroup.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilityfilterrulesconfignullable.mdx b/docs/models/observabilityfilterrulesconfignullable.mdx index b88550be7..9a46a0fca 100644 --- a/docs/models/observabilityfilterrulesconfignullable.mdx +++ b/docs/models/observabilityfilterrulesconfignullable.mdx @@ -27,5 +27,5 @@ let value: ObservabilityFilterRulesConfigNullable = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | -| `groups` | [models.ObservabilityFilterRuleGroup](../models/observabilityfilterrulegroup.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `enabled` | *boolean* | ➖ | N/A | +| `groups` | [models.ObservabilityFilterRuleGroup](../models/observabilityfilterrulegroup.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilitygrafanadestination.mdx b/docs/models/observabilitygrafanadestination.mdx index 111c6eaad..bfdb3b09f 100644 --- a/docs/models/observabilitygrafanadestination.mdx +++ b/docs/models/observabilitygrafanadestination.mdx @@ -37,19 +37,19 @@ let value: ObservabilityGrafanaDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityGrafanaDestinationConfig](../models/observabilitygrafanadestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"grafana"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityGrafanaDestinationConfig](../models/observabilitygrafanadestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"grafana"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitygrafanadestinationconfig.mdx b/docs/models/observabilitygrafanadestinationconfig.mdx index 293d36e5f..050854179 100644 --- a/docs/models/observabilitygrafanadestinationconfig.mdx +++ b/docs/models/observabilitygrafanadestinationconfig.mdx @@ -17,7 +17,7 @@ let value: ObservabilityGrafanaDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `instanceId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `apiKey` | *string* | ✅ | N/A | +| `baseUrl` | *string* | ➖ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `instanceId` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilitylangfusedestination.mdx b/docs/models/observabilitylangfusedestination.mdx index b2e00ffb0..0a3769efb 100644 --- a/docs/models/observabilitylangfusedestination.mdx +++ b/docs/models/observabilitylangfusedestination.mdx @@ -36,19 +36,19 @@ let value: ObservabilityLangfuseDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityLangfuseDestinationConfig](../models/observabilitylangfusedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"langfuse"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityLangfuseDestinationConfig](../models/observabilitylangfusedestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"langfuse"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitylangfusedestinationconfig.mdx b/docs/models/observabilitylangfusedestinationconfig.mdx index d4e499672..9577ce09f 100644 --- a/docs/models/observabilitylangfusedestinationconfig.mdx +++ b/docs/models/observabilitylangfusedestinationconfig.mdx @@ -17,7 +17,7 @@ let value: ObservabilityLangfuseDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `publicKey` | *string* | :heavy_check_mark: | N/A | -| `secretKey` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `baseUrl` | *string* | ➖ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `publicKey` | *string* | ✅ | N/A | +| `secretKey` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilitylangsmithdestination.mdx b/docs/models/observabilitylangsmithdestination.mdx index 4f854d210..2ea76d4c4 100644 --- a/docs/models/observabilitylangsmithdestination.mdx +++ b/docs/models/observabilitylangsmithdestination.mdx @@ -35,19 +35,19 @@ let value: ObservabilityLangsmithDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityLangsmithDestinationConfig](../models/observabilitylangsmithdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"langsmith"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityLangsmithDestinationConfig](../models/observabilitylangsmithdestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"langsmith"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitylangsmithdestinationconfig.mdx b/docs/models/observabilitylangsmithdestinationconfig.mdx index 91523095c..49def3d73 100644 --- a/docs/models/observabilitylangsmithdestinationconfig.mdx +++ b/docs/models/observabilitylangsmithdestinationconfig.mdx @@ -16,8 +16,8 @@ let value: ObservabilityLangsmithDestinationConfig = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `endpoint` | *string* | :heavy_minus_sign: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project` | *string* | :heavy_minus_sign: | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | -| `workspaceId` | *string* | :heavy_minus_sign: | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file +| `apiKey` | *string* | ✅ | N/A | +| `endpoint` | *string* | ➖ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `project` | *string* | ➖ | The name for this project, such as pr-openrouter-demo. Defaults to "main" if not set. | +| `workspaceId` | *string* | ➖ | Required for org-scoped API keys. Find this in your LangSmith workspace settings. | \ No newline at end of file diff --git a/docs/models/observabilitynewrelicdestination.mdx b/docs/models/observabilitynewrelicdestination.mdx index 217f56aa4..01d38380c 100644 --- a/docs/models/observabilitynewrelicdestination.mdx +++ b/docs/models/observabilitynewrelicdestination.mdx @@ -35,19 +35,19 @@ let value: ObservabilityNewrelicDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityNewrelicDestinationConfig](../models/observabilitynewrelicdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"newrelic"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityNewrelicDestinationConfig](../models/observabilitynewrelicdestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"newrelic"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitynewrelicdestinationconfig.mdx b/docs/models/observabilitynewrelicdestinationconfig.mdx index d588ede96..3a533df1d 100644 --- a/docs/models/observabilitynewrelicdestinationconfig.mdx +++ b/docs/models/observabilitynewrelicdestinationconfig.mdx @@ -16,6 +16,6 @@ let value: ObservabilityNewrelicDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `licenseKey` | *string* | :heavy_check_mark: | N/A | -| `region` | [models.Region](../models/region.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `licenseKey` | *string* | ✅ | N/A | +| `region` | [models.Region](../models/region.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/observabilityopikdestination.mdx b/docs/models/observabilityopikdestination.mdx index 980c3e8f8..ad5eab2a4 100644 --- a/docs/models/observabilityopikdestination.mdx +++ b/docs/models/observabilityopikdestination.mdx @@ -37,19 +37,19 @@ let value: ObservabilityOpikDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityOpikDestinationConfig](../models/observabilityopikdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"opik"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityOpikDestinationConfig](../models/observabilityopikdestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"opik"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilityopikdestinationconfig.mdx b/docs/models/observabilityopikdestinationconfig.mdx index 86a35277d..f3a187635 100644 --- a/docs/models/observabilityopikdestinationconfig.mdx +++ b/docs/models/observabilityopikdestinationconfig.mdx @@ -18,7 +18,7 @@ let value: ObservabilityOpikDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `projectName` | *string* | :heavy_check_mark: | N/A | -| `workspace` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `apiKey` | *string* | ✅ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `projectName` | *string* | ✅ | N/A | +| `workspace` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilityotelcollectordestination.mdx b/docs/models/observabilityotelcollectordestination.mdx index c8c6cf179..46078c751 100644 --- a/docs/models/observabilityotelcollectordestination.mdx +++ b/docs/models/observabilityotelcollectordestination.mdx @@ -35,19 +35,19 @@ let value: ObservabilityOtelCollectorDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityOtelCollectorDestinationConfig](../models/observabilityotelcollectordestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"otel-collector"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityOtelCollectorDestinationConfig](../models/observabilityotelcollectordestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"otel-collector"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilityotelcollectordestinationconfig.mdx b/docs/models/observabilityotelcollectordestinationconfig.mdx index dde76a159..5ce37c657 100644 --- a/docs/models/observabilityotelcollectordestinationconfig.mdx +++ b/docs/models/observabilityotelcollectordestinationconfig.mdx @@ -16,5 +16,5 @@ let value: ObservabilityOtelCollectorDestinationConfig = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `endpoint` | *string* | :heavy_check_mark: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers as a JSON object. For Axiom, use \{"Authorization": "Bearer xaat-xxx", "X-Axiom-Dataset": "your-dataset"} | \ No newline at end of file +| `endpoint` | *string* | ✅ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers as a JSON object. For Axiom, use \{"Authorization": "Bearer xaat-xxx", "X-Axiom-Dataset": "your-dataset"} | \ No newline at end of file diff --git a/docs/models/observabilityposthogdestination.mdx b/docs/models/observabilityposthogdestination.mdx index 7457cb725..f9d717dca 100644 --- a/docs/models/observabilityposthogdestination.mdx +++ b/docs/models/observabilityposthogdestination.mdx @@ -35,19 +35,19 @@ let value: ObservabilityPosthogDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityPosthogDestinationConfig](../models/observabilityposthogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"posthog"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityPosthogDestinationConfig](../models/observabilityposthogdestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"posthog"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilityposthogdestinationconfig.mdx b/docs/models/observabilityposthogdestinationconfig.mdx index 5ec87ae7b..82bf65e62 100644 --- a/docs/models/observabilityposthogdestinationconfig.mdx +++ b/docs/models/observabilityposthogdestinationconfig.mdx @@ -16,6 +16,6 @@ let value: ObservabilityPosthogDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `endpoint` | *string* | :heavy_minus_sign: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file +| `apiKey` | *string* | ✅ | N/A | +| `endpoint` | *string* | ➖ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | \ No newline at end of file diff --git a/docs/models/observabilityrampdestination.mdx b/docs/models/observabilityrampdestination.mdx index 9173e65e4..ac0ff1fd7 100644 --- a/docs/models/observabilityrampdestination.mdx +++ b/docs/models/observabilityrampdestination.mdx @@ -36,19 +36,19 @@ let value: ObservabilityRampDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityRampDestinationConfig](../models/observabilityrampdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"ramp"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityRampDestinationConfig](../models/observabilityrampdestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"ramp"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilityrampdestinationconfig.mdx b/docs/models/observabilityrampdestinationconfig.mdx index b1aa9c2d9..fdc952706 100644 --- a/docs/models/observabilityrampdestinationconfig.mdx +++ b/docs/models/observabilityrampdestinationconfig.mdx @@ -16,6 +16,6 @@ let value: ObservabilityRampDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | Generate this in your Ramp integration settings. | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file +| `apiKey` | *string* | ✅ | Generate this in your Ramp integration settings. | +| `baseUrl` | *string* | ➖ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to Ramp. | \ No newline at end of file diff --git a/docs/models/observabilitys3destination.mdx b/docs/models/observabilitys3destination.mdx index 3ca6f14ec..de4f0d0e1 100644 --- a/docs/models/observabilitys3destination.mdx +++ b/docs/models/observabilitys3destination.mdx @@ -37,19 +37,19 @@ let value: ObservabilityS3Destination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityS3DestinationConfig](../models/observabilitys3destinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"s3"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityS3DestinationConfig](../models/observabilitys3destinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"s3"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitys3destinationconfig.mdx b/docs/models/observabilitys3destinationconfig.mdx index 36ae3af6d..a8bb1be05 100644 --- a/docs/models/observabilitys3destinationconfig.mdx +++ b/docs/models/observabilitys3destinationconfig.mdx @@ -18,12 +18,12 @@ let value: ObservabilityS3DestinationConfig = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accessKeyId` | *string* | :heavy_check_mark: | N/A | -| `bucketName` | *string* | :heavy_check_mark: | N/A | -| `endpoint` | *string* | :heavy_minus_sign: | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `pathTemplate` | *string* | :heavy_minus_sign: | Template for S3 object path. The filename (\{traceId}-\{timestamp}.json) is automatically appended. Available variables: \{prefix}, \{date}, \{year}, \{month}, \{day}, \{apiKeyName} | -| `prefix` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `secretAccessKey` | *string* | :heavy_check_mark: | N/A | -| `sessionToken` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `accessKeyId` | *string* | ✅ | N/A | +| `bucketName` | *string* | ✅ | N/A | +| `endpoint` | *string* | ➖ | Only for S3-compatible services like Cloudflare R2 (https://account-id.r2.cloudflarestorage.com) or MinIO. Leave blank for standard AWS S3. | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `pathTemplate` | *string* | ➖ | Template for S3 object path. The filename (\{traceId}-\{timestamp}.json) is automatically appended. Available variables: \{prefix}, \{date}, \{year}, \{month}, \{day}, \{apiKeyName} | +| `prefix` | *string* | ➖ | N/A | +| `region` | *string* | ➖ | N/A | +| `secretAccessKey` | *string* | ✅ | N/A | +| `sessionToken` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/observabilitysentrydestination.mdx b/docs/models/observabilitysentrydestination.mdx index 15325e258..da8ec9b8a 100644 --- a/docs/models/observabilitysentrydestination.mdx +++ b/docs/models/observabilitysentrydestination.mdx @@ -36,19 +36,19 @@ let value: ObservabilitySentryDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilitySentryDestinationConfig](../models/observabilitysentrydestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"sentry"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilitySentryDestinationConfig](../models/observabilitysentrydestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"sentry"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitysentrydestinationconfig.mdx b/docs/models/observabilitysentrydestinationconfig.mdx index 25a10b2da..a8232faad 100644 --- a/docs/models/observabilitysentrydestinationconfig.mdx +++ b/docs/models/observabilitysentrydestinationconfig.mdx @@ -17,6 +17,6 @@ let value: ObservabilitySentryDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `dsn` | *string* | :heavy_check_mark: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `otlpEndpoint` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `dsn` | *string* | ✅ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `otlpEndpoint` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilitysnowflakedestination.mdx b/docs/models/observabilitysnowflakedestination.mdx index 111e5b1f4..8d129d4c8 100644 --- a/docs/models/observabilitysnowflakedestination.mdx +++ b/docs/models/observabilitysnowflakedestination.mdx @@ -36,19 +36,19 @@ let value: ObservabilitySnowflakeDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilitySnowflakeDestinationConfig](../models/observabilitysnowflakedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"snowflake"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilitySnowflakeDestinationConfig](../models/observabilitysnowflakedestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"snowflake"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitysnowflakedestinationconfig.mdx b/docs/models/observabilitysnowflakedestinationconfig.mdx index acc9fb7af..cd0bf0bdb 100644 --- a/docs/models/observabilitysnowflakedestinationconfig.mdx +++ b/docs/models/observabilitysnowflakedestinationconfig.mdx @@ -17,11 +17,11 @@ let value: ObservabilitySnowflakeDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `account` | *string* | :heavy_check_mark: | N/A | -| `database` | *string* | :heavy_minus_sign: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `schema` | *string* | :heavy_minus_sign: | N/A | -| `shouldIncludeCacheWriteTokens` | *boolean* | :heavy_minus_sign: | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | -| `table` | *string* | :heavy_minus_sign: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | -| `warehouse` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `account` | *string* | ✅ | N/A | +| `database` | *string* | ➖ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `schema` | *string* | ➖ | N/A | +| `shouldIncludeCacheWriteTokens` | *boolean* | ➖ | Send the cache_write_tokens column (schema v2). Turn this on after the table has that column. | +| `table` | *string* | ➖ | N/A | +| `token` | *string* | ✅ | N/A | +| `warehouse` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/observabilityweavedestination.mdx b/docs/models/observabilityweavedestination.mdx index ce140ada3..202b2d400 100644 --- a/docs/models/observabilityweavedestination.mdx +++ b/docs/models/observabilityweavedestination.mdx @@ -38,19 +38,19 @@ let value: ObservabilityWeaveDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityWeaveDestinationConfig](../models/observabilityweavedestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"weave"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityWeaveDestinationConfig](../models/observabilityweavedestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"weave"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilityweavedestinationconfig.mdx b/docs/models/observabilityweavedestinationconfig.mdx index 0873dc20e..b88f1fa9b 100644 --- a/docs/models/observabilityweavedestinationconfig.mdx +++ b/docs/models/observabilityweavedestinationconfig.mdx @@ -18,8 +18,8 @@ let value: ObservabilityWeaveDestinationConfig = { | Field | Type | Required | Description | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_check_mark: | N/A | -| `baseUrl` | *string* | :heavy_minus_sign: | N/A | -| `entity` | *string* | :heavy_check_mark: | N/A | -| `headers` | Record\ | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | -| `project` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `apiKey` | *string* | ✅ | N/A | +| `baseUrl` | *string* | ➖ | N/A | +| `entity` | *string* | ✅ | N/A | +| `headers` | Record\ | ➖ | Custom HTTP headers to include in requests to this destination. | +| `project` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/observabilitywebhookdestination.mdx b/docs/models/observabilitywebhookdestination.mdx index 6fe795d29..8d324d967 100644 --- a/docs/models/observabilitywebhookdestination.mdx +++ b/docs/models/observabilitywebhookdestination.mdx @@ -35,19 +35,19 @@ let value: ObservabilityWebhookDestination = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_check_mark: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_check_mark: | When true, include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_check_mark: | When true, include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_check_mark: | When true, include request-context generation metadata. | false | -| `config` | [models.ObservabilityWebhookDestinationConfig](../models/observabilitywebhookdestinationconfig.mdx) | :heavy_check_mark: | N/A | | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | -| `enabled` | *boolean* | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | -| `id` | *string* | :heavy_check_mark: | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `name` | *string* | :heavy_check_mark: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | -| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | :heavy_check_mark: | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | -| `samplingRate` | *number* | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `type` | *"webhook"* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ✅ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) whose traffic is forwarded to this destination. `null` means all keys. | null | +| `broadcastGenerationCost` | *boolean* | ✅ | When true, include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ✅ | When true, include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ✅ | When true, include request-context generation metadata. | false | +| `config` | [models.ObservabilityWebhookDestinationConfig](../models/observabilitywebhookdestinationconfig.mdx) | ✅ | N/A | | +| `createdAt` | *string* | ✅ | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | +| `enabled` | *boolean* | ✅ | Whether this destination is currently enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfig](../models/observabilityfilterrulesconfig.mdx) | ✅ | Optional structured filter rules controlling which events are forwarded. | null | +| `id` | *string* | ✅ | Stable public identifier for this destination. | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `name` | *string* | ✅ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ✅ | When true, request/response bodies are not forwarded to this destination — only metadata. | false | +| `regions` | [models.ObservabilityDataRegion](../models/observabilitydataregion.mdx)[] | ✅ | Data regions this destination applies to. Requests served in a region only fan out to destinations that include that region. | [
"global"
] | +| `samplingRate` | *number* | ✅ | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | +| `type` | *"webhook"* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | ISO timestamp of when the destination was last updated. | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace this destination belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/observabilitywebhookdestinationconfig.mdx b/docs/models/observabilitywebhookdestinationconfig.mdx index 3ff0afc1e..bc5156616 100644 --- a/docs/models/observabilitywebhookdestinationconfig.mdx +++ b/docs/models/observabilitywebhookdestinationconfig.mdx @@ -16,6 +16,6 @@ let value: ObservabilityWebhookDestinationConfig = { | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `headers` | Record\ | :heavy_minus_sign: | N/A | -| `method` | [models.Method](../models/method.mdx) | :heavy_minus_sign: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `headers` | Record\ | ➖ | N/A | +| `method` | [models.Method](../models/method.mdx) | ➖ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openaifile.mdx b/docs/models/openaifile.mdx index 95818cbc1..806875255 100644 --- a/docs/models/openaifile.mdx +++ b/docs/models/openaifile.mdx @@ -25,11 +25,11 @@ let value: OpenAIFile = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `shape` | [models.OpenAIFileShape](../models/openaifileshape.mdx) | :heavy_check_mark: | N/A | -| `bytes` | *number* | :heavy_check_mark: | N/A | -| `createdAt` | *number* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.OpenAIFileObject](../models/openaifileobject.mdx) | :heavy_check_mark: | N/A | -| `purpose` | [models.Purpose](../models/purpose.mdx) | :heavy_check_mark: | N/A | -| `status` | [models.OpenAIFileStatus](../models/openaifilestatus.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [models.OpenAIFileShape](../models/openaifileshape.mdx) | ✅ | N/A | +| `bytes` | *number* | ✅ | N/A | +| `createdAt` | *number* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `object` | [models.OpenAIFileObject](../models/openaifileobject.mdx) | ✅ | N/A | +| `purpose` | [models.Purpose](../models/purpose.mdx) | ✅ | N/A | +| `status` | [models.OpenAIFileStatus](../models/openaifilestatus.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openaifiledeleted.mdx b/docs/models/openaifiledeleted.mdx index 41be61058..adeaac4d6 100644 --- a/docs/models/openaifiledeleted.mdx +++ b/docs/models/openaifiledeleted.mdx @@ -21,7 +21,7 @@ let value: OpenAIFileDeleted = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `shape` | *"openai"* | :heavy_check_mark: | N/A | -| `deleted` | *true* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.OpenAIFileDeletedObject](../models/openaifiledeletedobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | *"openai"* | ✅ | N/A | +| `deleted` | *true* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `object` | [models.OpenAIFileDeletedObject](../models/openaifiledeletedobject.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openaifilelist.mdx b/docs/models/openaifilelist.mdx index 94cde56c4..b43730b55 100644 --- a/docs/models/openaifilelist.mdx +++ b/docs/models/openaifilelist.mdx @@ -23,9 +23,9 @@ let value: OpenAIFileList = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `shape` | *"openai"* | :heavy_check_mark: | N/A | -| `data` | [models.OpenAIFile](../models/openaifile.mdx)[] | :heavy_check_mark: | N/A | -| `firstId` | *string* | :heavy_check_mark: | N/A | -| `hasMore` | *boolean* | :heavy_check_mark: | N/A | -| `lastId` | *string* | :heavy_check_mark: | N/A | -| `object` | [models.OpenAIFileListObject](../models/openaifilelistobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | *"openai"* | ✅ | N/A | +| `data` | [models.OpenAIFile](../models/openaifile.mdx)[] | ✅ | N/A | +| `firstId` | *string* | ✅ | N/A | +| `hasMore` | *boolean* | ✅ | N/A | +| `lastId` | *string* | ✅ | N/A | +| `object` | [models.OpenAIFileListObject](../models/openaifilelistobject.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsecustomtoolcall.mdx b/docs/models/openairesponsecustomtoolcall.mdx index 367e9378b..9e25e5c31 100644 --- a/docs/models/openairesponsecustomtoolcall.mdx +++ b/docs/models/openairesponsecustomtoolcall.mdx @@ -19,10 +19,10 @@ let value: OpenAIResponseCustomToolCall = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `async` | *boolean* | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `input` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `type` | [models.OpenAIResponseCustomToolCallType](../models/openairesponsecustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async` | *boolean* | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `input` | *string* | ✅ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `namespace` | *string* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `type` | [models.OpenAIResponseCustomToolCallType](../models/openairesponsecustomtoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/openairesponsecustomtoolcalloutput.mdx b/docs/models/openairesponsecustomtoolcalloutput.mdx index cb6950272..2362abfeb 100644 --- a/docs/models/openairesponsecustomtoolcalloutput.mdx +++ b/docs/models/openairesponsecustomtoolcalloutput.mdx @@ -18,7 +18,7 @@ let value: OpenAIResponseCustomToolCallOutput = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `output` | *models.OpenAIResponseCustomToolCallOutputOutput2* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponseCustomToolCallOutputType](../models/openairesponsecustomtoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | +| `id` | *string* | ➖ | N/A | +| `output` | *models.OpenAIResponseCustomToolCallOutputOutput2* | ✅ | N/A | +| `type` | [models.OpenAIResponseCustomToolCallOutputType](../models/openairesponsecustomtoolcalloutputtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsefunctiontoolcall.mdx b/docs/models/openairesponsefunctiontoolcall.mdx index 7085f8300..b82a752aa 100644 --- a/docs/models/openairesponsefunctiontoolcall.mdx +++ b/docs/models/openairesponsefunctiontoolcall.mdx @@ -19,13 +19,13 @@ let value: OpenAIResponseFunctionToolCall = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `async` | *boolean* | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `subagentId` | *string* | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | -| `subagentItems` | [models.OpenAIResponseFunctionToolCallSubagentItem](../models/openairesponsefunctiontoolcallsubagentitem.mdx)[] | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | -| `type` | [models.OpenAIResponseFunctionToolCallType](../models/openairesponsefunctiontoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | | +| `async` | *boolean* | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `namespace` | *string* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ➖ | N/A | completed | +| `subagentId` | *string* | ➖ | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | +| `subagentItems` | [models.OpenAIResponseFunctionToolCallSubagentItem](../models/openairesponsefunctiontoolcallsubagentitem.mdx)[] | ➖ | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | +| `type` | [models.OpenAIResponseFunctionToolCallType](../models/openairesponsefunctiontoolcalltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/openairesponsefunctiontoolcalloutput.mdx b/docs/models/openairesponsefunctiontoolcalloutput.mdx index 190ddbcff..99059aa78 100644 --- a/docs/models/openairesponsefunctiontoolcalloutput.mdx +++ b/docs/models/openairesponsefunctiontoolcalloutput.mdx @@ -18,8 +18,8 @@ let value: OpenAIResponseFunctionToolCallOutput = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `output` | *models.OpenAIResponseFunctionToolCallOutputOutput2* | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.OpenAIResponseFunctionToolCallOutputType](../models/openairesponsefunctiontoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `output` | *models.OpenAIResponseFunctionToolCallOutputOutput2* | ✅ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [models.OpenAIResponseFunctionToolCallOutputType](../models/openairesponsefunctiontoolcalloutputtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/openairesponsefunctiontoolcallsubagentitem.mdx b/docs/models/openairesponsefunctiontoolcallsubagentitem.mdx index 6d85dfbfa..8266e593e 100644 --- a/docs/models/openairesponsefunctiontoolcallsubagentitem.mdx +++ b/docs/models/openairesponsefunctiontoolcallsubagentitem.mdx @@ -16,5 +16,5 @@ let value: OpenAIResponseFunctionToolCallSubagentItem = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *string* | ✅ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/openairesponseinputmessageitem.mdx b/docs/models/openairesponseinputmessageitem.mdx index 9cab2c14a..3c5b387ea 100644 --- a/docs/models/openairesponseinputmessageitem.mdx +++ b/docs/models/openairesponseinputmessageitem.mdx @@ -23,7 +23,7 @@ let value: OpenAIResponseInputMessageItem = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `content` | *models.OpenAIResponseInputMessageItemContent*[] | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `role` | *models.OpenAIResponseInputMessageItemRoleUnion* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponseInputMessageItemType](../models/openairesponseinputmessageitemtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `content` | *models.OpenAIResponseInputMessageItemContent*[] | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `role` | *models.OpenAIResponseInputMessageItemRoleUnion* | ✅ | N/A | +| `type` | [models.OpenAIResponseInputMessageItemType](../models/openairesponseinputmessageitemtype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsesrefusalcontent.mdx b/docs/models/openairesponsesrefusalcontent.mdx index 8d161774f..7dc6bea0e 100644 --- a/docs/models/openairesponsesrefusalcontent.mdx +++ b/docs/models/openairesponsesrefusalcontent.mdx @@ -17,5 +17,5 @@ let value: OpenAIResponsesRefusalContent = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `refusal` | *string* | :heavy_check_mark: | N/A | -| `type` | *"refusal"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `refusal` | *string* | ✅ | N/A | +| `type` | *"refusal"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsestoolchoice.mdx b/docs/models/openairesponsestoolchoice.mdx index 37acf0064..6a965066f 100644 --- a/docs/models/openairesponsestoolchoice.mdx +++ b/docs/models/openairesponsestoolchoice.mdx @@ -16,4 +16,4 @@ let value: OpenAIResponsesToolChoice = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *models.Type* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *models.Type* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsestoolchoiceapplypatch.mdx b/docs/models/openairesponsestoolchoiceapplypatch.mdx index c0fb820df..686e85b50 100644 --- a/docs/models/openairesponsestoolchoiceapplypatch.mdx +++ b/docs/models/openairesponsestoolchoiceapplypatch.mdx @@ -16,4 +16,4 @@ let value: OpenAIResponsesToolChoiceApplyPatch = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `type` | [models.OpenAIResponsesToolChoiceTypeApplyPatch](../models/openairesponsestoolchoicetypeapplypatch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OpenAIResponsesToolChoiceTypeApplyPatch](../models/openairesponsestoolchoicetypeapplypatch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsestoolchoicefunction.mdx b/docs/models/openairesponsestoolchoicefunction.mdx index de1714e19..58d8e11b8 100644 --- a/docs/models/openairesponsestoolchoicefunction.mdx +++ b/docs/models/openairesponsestoolchoicefunction.mdx @@ -17,5 +17,5 @@ let value: OpenAIResponsesToolChoiceFunction = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `name` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.OpenAIResponsesToolChoiceTypeFunction](../models/openairesponsestoolchoicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `name` | *string* | ✅ | N/A | +| `type` | [models.OpenAIResponsesToolChoiceTypeFunction](../models/openairesponsestoolchoicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openairesponsestoolchoiceshell.mdx b/docs/models/openairesponsestoolchoiceshell.mdx index 9adcdeccb..cd71cb2eb 100644 --- a/docs/models/openairesponsestoolchoiceshell.mdx +++ b/docs/models/openairesponsestoolchoiceshell.mdx @@ -16,4 +16,4 @@ let value: OpenAIResponsesToolChoiceShell = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `type` | [models.OpenAIResponsesToolChoiceTypeShell](../models/openairesponsestoolchoicetypeshell.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OpenAIResponsesToolChoiceTypeShell](../models/openairesponsestoolchoicetypeshell.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openresponsescreatedevent.mdx b/docs/models/openresponsescreatedevent.mdx index 481686da2..0e3489231 100644 --- a/docs/models/openresponsescreatedevent.mdx +++ b/docs/models/openresponsescreatedevent.mdx @@ -39,6 +39,6 @@ let value: OpenResponsesCreatedEvent = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.created"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `type` | *"response.created"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/openresponseserrorfield.mdx b/docs/models/openresponseserrorfield.mdx index 834b0f7da..1f64621a5 100644 --- a/docs/models/openresponseserrorfield.mdx +++ b/docs/models/openresponseserrorfield.mdx @@ -20,6 +20,6 @@ let value: OpenResponsesErrorField = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `code` | [models.CodeEnum](../models/codeenum.mdx) | :heavy_check_mark: | N/A | | -| `message` | *string* | :heavy_check_mark: | N/A | | -| `metadata` | [models.OpenResponsesErrorMetadata](../models/openresponseserrormetadata.mdx) | :heavy_minus_sign: | OpenRouter-specific details of a failed response, such as the alignment object of an alignment error. | \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
} | \ No newline at end of file +| `code` | [models.CodeEnum](../models/codeenum.mdx) | ✅ | N/A | | +| `message` | *string* | ✅ | N/A | | +| `metadata` | [models.OpenResponsesErrorMetadata](../models/openresponseserrormetadata.mdx) | ➖ | OpenRouter-specific details of a failed response, such as the alignment object of an alignment error. | \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
} | \ No newline at end of file diff --git a/docs/models/openresponseserrormetadata.mdx b/docs/models/openresponseserrormetadata.mdx index 5b1c3ec31..766b604e6 100644 --- a/docs/models/openresponseserrormetadata.mdx +++ b/docs/models/openresponseserrormetadata.mdx @@ -16,4 +16,4 @@ let value: OpenResponsesErrorMetadata = {}; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `alignment` | [models.OpenResponsesErrorMetadataAlignment](../models/openresponseserrormetadataalignment.mdx) | :heavy_minus_sign: | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | \ No newline at end of file +| `alignment` | [models.OpenResponsesErrorMetadataAlignment](../models/openresponseserrormetadataalignment.mdx) | ➖ | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | \ No newline at end of file diff --git a/docs/models/openresponseserrormetadataalignment.mdx b/docs/models/openresponseserrormetadataalignment.mdx index 244add5e9..d3174a4dd 100644 --- a/docs/models/openresponseserrormetadataalignment.mdx +++ b/docs/models/openresponseserrormetadataalignment.mdx @@ -29,5 +29,5 @@ let value: OpenResponsesErrorMetadataAlignment = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `calls` | *models.AlignmentCallRecord*[] | :heavy_check_mark: | One record per evaluated assistant message of the request, in the order the messages were produced. | -| `rejected` | *models.AlignmentRejected* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `calls` | *models.AlignmentCallRecord*[] | ✅ | One record per evaluated assistant message of the request, in the order the messages were produced. | +| `rejected` | *models.AlignmentRejected* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/openresponsesinprogressevent.mdx b/docs/models/openresponsesinprogressevent.mdx index c10478623..55afe5a7f 100644 --- a/docs/models/openresponsesinprogressevent.mdx +++ b/docs/models/openresponsesinprogressevent.mdx @@ -39,6 +39,6 @@ let value: OpenResponsesInProgressEvent = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.in_progress"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `type` | *"response.in_progress"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/openresponsesresult.mdx b/docs/models/openresponsesresult.mdx index bc12bff14..b55881171 100644 --- a/docs/models/openresponsesresult.mdx +++ b/docs/models/openresponsesresult.mdx @@ -47,41 +47,41 @@ let value: OpenResponsesResult = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *boolean* | :heavy_minus_sign: | N/A | | -| `completedAt` | *number* | :heavy_check_mark: | N/A | | -| `createdAt` | *number* | :heavy_check_mark: | N/A | | -| `error` | [models.OpenResponsesErrorField](../models/openresponseserrorfield.mdx) | :heavy_check_mark: | Error of a failed response; `metadata` carries OpenRouter-specific details. | \{
"code": "server_error",
"message": "Alignment plugin: the reply could not be evaluated: evaluator_error",
"metadata": \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
}
} | -| `frequencyPenalty` | *number* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `incompleteDetails` | [models.IncompleteDetails](../models/incompletedetails.mdx) | :heavy_check_mark: | N/A | \{
"reason": "max_output_tokens"
} | -| `instructions` | *models.BaseInputsUnion* | :heavy_check_mark: | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | -| `maxOutputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `maxToolCalls` | *number* | :heavy_minus_sign: | N/A | | -| `metadata` | Record\ | :heavy_check_mark: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `object` | [models.OpenResponsesResultObject](../models/openresponsesresultobject.mdx) | :heavy_check_mark: | N/A | | -| `output` | *models.OutputItems*[] | :heavy_check_mark: | N/A | | -| `outputText` | *string* | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_check_mark: | N/A | | -| `presencePenalty` | *number* | :heavy_check_mark: | N/A | | -| `previousResponseId` | *string* | :heavy_minus_sign: | N/A | | -| `prompt` | [models.StoredPromptTemplate](../models/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `promptCacheOptions` | [models.PromptCacheOptions](../models/promptcacheoptions.mdx) | :heavy_minus_sign: | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | -| `reasoning` | [models.BaseReasoningConfig](../models/basereasoningconfig.mdx) | :heavy_minus_sign: | N/A | \{
"effort": "medium",
"summary": "auto"
} | -| `safetyIdentifier` | *string* | :heavy_minus_sign: | N/A | | -| `serviceTier` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.OpenAIResponsesResponseStatus](../models/openairesponsesresponsestatus.mdx) | :heavy_check_mark: | N/A | completed | -| `store` | *boolean* | :heavy_minus_sign: | N/A | | -| `temperature` | *number* | :heavy_check_mark: | N/A | | -| `text` | [models.TextExtendedConfig](../models/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | :heavy_check_mark: | N/A | auto | -| `tools` | *models.OpenResponsesResultToolUnion*[] | :heavy_check_mark: | N/A | | -| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | | -| `topP` | *number* | :heavy_check_mark: | N/A | | -| `truncation` | [models.Truncation](../models/truncation.mdx) | :heavy_minus_sign: | N/A | auto | -| `usage` | [models.Usage](../models/usage.mdx) | :heavy_minus_sign: | Token usage information for the response | \{
"cost": 0.0012,
"cost_details": \{
"upstream_inference_cost": null,
"upstream_inference_input_cost": 0.0008,
"upstream_inference_output_cost": 0.0004
},
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
} | -| `user` | *string* | :heavy_minus_sign: | N/A | | -| `alignment` | [models.Alignment](../models/alignment.mdx) | :heavy_minus_sign: | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | -| `errorType` | [models.ApiErrorType](../models/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | \ No newline at end of file +| `background` | *boolean* | ➖ | N/A | | +| `completedAt` | *number* | ✅ | N/A | | +| `createdAt` | *number* | ✅ | N/A | | +| `error` | [models.OpenResponsesErrorField](../models/openresponseserrorfield.mdx) | ✅ | Error of a failed response; `metadata` carries OpenRouter-specific details. | \{
"code": "server_error",
"message": "Alignment plugin: the reply could not be evaluated: evaluator_error",
"metadata": \{
"alignment": \{
"calls": [
\{
"call": 1,
"outcome": "unavailable",
"reason": "evaluator_error"
}
]
}
}
} | +| `frequencyPenalty` | *number* | ✅ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `incompleteDetails` | [models.IncompleteDetails](../models/incompletedetails.mdx) | ✅ | N/A | \{
"reason": "max_output_tokens"
} | +| `instructions` | *models.BaseInputsUnion* | ✅ | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `maxOutputTokens` | *number* | ➖ | N/A | | +| `maxToolCalls` | *number* | ➖ | N/A | | +| `metadata` | Record\ | ✅ | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | +| `model` | *string* | ✅ | N/A | | +| `object` | [models.OpenResponsesResultObject](../models/openresponsesresultobject.mdx) | ✅ | N/A | | +| `output` | *models.OutputItems*[] | ✅ | N/A | | +| `outputText` | *string* | ➖ | N/A | | +| `parallelToolCalls` | *boolean* | ✅ | N/A | | +| `presencePenalty` | *number* | ✅ | N/A | | +| `previousResponseId` | *string* | ➖ | N/A | | +| `prompt` | [models.StoredPromptTemplate](../models/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `promptCacheKey` | *string* | ➖ | N/A | | +| `promptCacheOptions` | [models.PromptCacheOptions](../models/promptcacheoptions.mdx) | ➖ | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | +| `reasoning` | [models.BaseReasoningConfig](../models/basereasoningconfig.mdx) | ➖ | N/A | \{
"effort": "medium",
"summary": "auto"
} | +| `safetyIdentifier` | *string* | ➖ | N/A | | +| `serviceTier` | *string* | ➖ | N/A | | +| `status` | [models.OpenAIResponsesResponseStatus](../models/openairesponsesresponsestatus.mdx) | ✅ | N/A | completed | +| `store` | *boolean* | ➖ | N/A | | +| `temperature` | *number* | ✅ | N/A | | +| `text` | [models.TextExtendedConfig](../models/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | ✅ | N/A | auto | +| `tools` | *models.OpenResponsesResultToolUnion*[] | ✅ | N/A | | +| `topLogprobs` | *number* | ➖ | N/A | | +| `topP` | *number* | ✅ | N/A | | +| `truncation` | [models.Truncation](../models/truncation.mdx) | ➖ | N/A | auto | +| `usage` | [models.Usage](../models/usage.mdx) | ➖ | Token usage information for the response | \{
"cost": 0.0012,
"cost_details": \{
"upstream_inference_cost": null,
"upstream_inference_input_cost": 0.0008,
"upstream_inference_output_cost": 0.0004
},
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
} | +| `user` | *string* | ➖ | N/A | | +| `alignment` | [models.Alignment](../models/alignment.mdx) | ➖ | Beta. The result of the alignment plugin for this request; the shape may change. | \{
"calls": [
\{
"call": 1,
"outcome": "allowed",
"rules": [
\{
"broken": false,
"probability": 0.04
}
]
}
]
} | +| `errorType` | [models.ApiErrorType](../models/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `openrouterMetadata` | [models.OpenRouterMetadata](../models/openroutermetadata.mdx) | ➖ | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"generation_time": 2016,
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | \ No newline at end of file diff --git a/docs/models/openresponsesresulttoolfunction.mdx b/docs/models/openresponsesresulttoolfunction.mdx index e770c09dd..fdaa4af43 100644 --- a/docs/models/openresponsesresulttoolfunction.mdx +++ b/docs/models/openresponsesresulttoolfunction.mdx @@ -39,10 +39,10 @@ let value: OpenResponsesResultToolFunction = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `parameters` | Record\ | :heavy_check_mark: | N/A | | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | | -| `type` | *"function"* | :heavy_check_mark: | N/A | | -| `async` | *boolean* | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `deferLoading` | *boolean* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `description` | *string* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `parameters` | Record\ | ✅ | N/A | | +| `strict` | *boolean* | ➖ | N/A | | +| `type` | *"function"* | ✅ | N/A | | +| `async` | *boolean* | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `deferLoading` | *boolean* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/openrouterfile.mdx b/docs/models/openrouterfile.mdx index 812404832..9f3abcb11 100644 --- a/docs/models/openrouterfile.mdx +++ b/docs/models/openrouterfile.mdx @@ -25,11 +25,11 @@ let value: OpenRouterFile = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `shape` | [models.OpenRouterFileShape](../models/openrouterfileshape.mdx) | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `downloadable` | *boolean* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `mimeType` | *string* | :heavy_check_mark: | N/A | -| `sizeBytes` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.OpenRouterFileType](../models/openrouterfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | [models.OpenRouterFileShape](../models/openrouterfileshape.mdx) | ✅ | N/A | +| `createdAt` | *string* | ✅ | N/A | +| `downloadable` | *boolean* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `mimeType` | *string* | ✅ | N/A | +| `sizeBytes` | *number* | ✅ | N/A | +| `type` | [models.OpenRouterFileType](../models/openrouterfiletype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openrouterfiledeleted.mdx b/docs/models/openrouterfiledeleted.mdx index f181dd5bf..20b63cc5d 100644 --- a/docs/models/openrouterfiledeleted.mdx +++ b/docs/models/openrouterfiledeleted.mdx @@ -20,6 +20,6 @@ let value: OpenRouterFileDeleted = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `shape` | *"openrouter"* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.OpenRouterFileDeletedType](../models/openrouterfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | *"openrouter"* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `type` | [models.OpenRouterFileDeletedType](../models/openrouterfiledeletedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openrouterfilelist.mdx b/docs/models/openrouterfilelist.mdx index b313f25d2..a7f560513 100644 --- a/docs/models/openrouterfilelist.mdx +++ b/docs/models/openrouterfilelist.mdx @@ -23,9 +23,9 @@ let value: OpenRouterFileList = { | Field | Type | Required | Description | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `shape` | *"openrouter"* | :heavy_check_mark: | N/A | -| `cursor` | *string* | :heavy_check_mark: | Opaque cursor for the next page; null when there are no more results. | -| `data` | [models.OpenRouterFile](../models/openrouterfile.mdx)[] | :heavy_check_mark: | N/A | -| `firstId` | *string* | :heavy_check_mark: | N/A | -| `hasMore` | *boolean* | :heavy_check_mark: | N/A | -| `lastId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `shape` | *"openrouter"* | ✅ | N/A | +| `cursor` | *string* | ✅ | Opaque cursor for the next page; null when there are no more results. | +| `data` | [models.OpenRouterFile](../models/openrouterfile.mdx)[] | ✅ | N/A | +| `firstId` | *string* | ✅ | N/A | +| `hasMore` | *boolean* | ✅ | N/A | +| `lastId` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/openroutermetadata.mdx b/docs/models/openroutermetadata.mdx index 0b6db2219..122584a20 100644 --- a/docs/models/openroutermetadata.mdx +++ b/docs/models/openroutermetadata.mdx @@ -31,14 +31,14 @@ let value: OpenRouterMetadata = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `attempt` | *number* | :heavy_check_mark: | N/A | | -| `attempts` | [models.RouterAttempt](../models/routerattempt.mdx)[] | :heavy_minus_sign: | N/A | | -| `endpoints` | [models.EndpointsMetadata](../models/endpointsmetadata.mdx) | :heavy_check_mark: | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | -| `generationTime` | *number* | :heavy_minus_sign: | Milliseconds measured for the generation, from dispatching the upstream request until its response body ended. Divide the completion token count by this for throughput. Absent when no upstream request was dispatched. | 2016 | -| `isByok` | *boolean* | :heavy_check_mark: | N/A | | -| `params` | [models.RouterParams](../models/routerparams.mdx) | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | -| `pipeline` | [models.PipelineStage](../models/pipelinestage.mdx)[] | :heavy_minus_sign: | N/A | | -| `region` | *string* | :heavy_check_mark: | N/A | | -| `requested` | *string* | :heavy_check_mark: | N/A | | -| `strategy` | [models.RoutingStrategy](../models/routingstrategy.mdx) | :heavy_check_mark: | N/A | direct | -| `summary` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `attempt` | *number* | ✅ | N/A | | +| `attempts` | [models.RouterAttempt](../models/routerattempt.mdx)[] | ➖ | N/A | | +| `endpoints` | [models.EndpointsMetadata](../models/endpointsmetadata.mdx) | ✅ | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | +| `generationTime` | *number* | ➖ | Milliseconds measured for the generation, from dispatching the upstream request until its response body ended. Divide the completion token count by this for throughput. Absent when no upstream request was dispatched. | 2016 | +| `isByok` | *boolean* | ✅ | N/A | | +| `params` | [models.RouterParams](../models/routerparams.mdx) | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | +| `pipeline` | [models.PipelineStage](../models/pipelinestage.mdx)[] | ➖ | N/A | | +| `region` | *string* | ✅ | N/A | | +| `requested` | *string* | ✅ | N/A | | +| `strategy` | [models.RoutingStrategy](../models/routingstrategy.mdx) | ✅ | N/A | direct | +| `summary` | *string* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/openrouterwebsearchservertool.mdx b/docs/models/openrouterwebsearchservertool.mdx index 61b3a32cc..047d1412a 100644 --- a/docs/models/openrouterwebsearchservertool.mdx +++ b/docs/models/openrouterwebsearchservertool.mdx @@ -18,5 +18,5 @@ let value: OpenRouterWebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `parameters` | [models.WebSearchConfig](../models/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `type` | [models.OpenRouterWebSearchServerToolType](../models/openrouterwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.WebSearchConfig](../models/websearchconfig.mdx) | ➖ | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `type` | [models.OpenRouterWebSearchServerToolType](../models/openrouterwebsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/activateprivateendpointglobals.mdx b/docs/models/operations/activateprivateendpointglobals.mdx index 327237c10..f3a61da72 100644 --- a/docs/models/operations/activateprivateendpointglobals.mdx +++ b/docs/models/operations/activateprivateendpointglobals.mdx @@ -14,6 +14,6 @@ let value: ActivatePrivateEndpointGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/activateprivateendpointrequest.mdx b/docs/models/operations/activateprivateendpointrequest.mdx index e96edc41b..2ecb0b2b1 100644 --- a/docs/models/operations/activateprivateendpointrequest.mdx +++ b/docs/models/operations/activateprivateendpointrequest.mdx @@ -16,7 +16,7 @@ let value: ActivatePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/bulkaddworkspacemembersglobals.mdx b/docs/models/operations/bulkaddworkspacemembersglobals.mdx index 07f3507b2..27417838b 100644 --- a/docs/models/operations/bulkaddworkspacemembersglobals.mdx +++ b/docs/models/operations/bulkaddworkspacemembersglobals.mdx @@ -14,6 +14,6 @@ let value: BulkAddWorkspaceMembersGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/bulkaddworkspacemembersrequest.mdx b/docs/models/operations/bulkaddworkspacemembersrequest.mdx index af0ad1e5d..f250ed201 100644 --- a/docs/models/operations/bulkaddworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkaddworkspacemembersrequest.mdx @@ -22,8 +22,8 @@ let value: BulkAddWorkspaceMembersRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkAddWorkspaceMembersRequest` | [models.BulkAddWorkspaceMembersRequest](../../models/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The workspace ID (UUID) or slug | production | +| `bulkAddWorkspaceMembersRequest` | [models.BulkAddWorkspaceMembersRequest](../../models/bulkaddworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignkeystoguardrailglobals.mdx b/docs/models/operations/bulkassignkeystoguardrailglobals.mdx index af813ef54..23942ca66 100644 --- a/docs/models/operations/bulkassignkeystoguardrailglobals.mdx +++ b/docs/models/operations/bulkassignkeystoguardrailglobals.mdx @@ -14,6 +14,6 @@ let value: BulkAssignKeysToGuardrailGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx index 08f990e31..5b882c399 100644 --- a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx @@ -21,8 +21,8 @@ let value: BulkAssignKeysToGuardrailRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignKeysRequest` | [models.BulkAssignKeysRequest](../../models/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkAssignKeysRequest` | [models.BulkAssignKeysRequest](../../models/bulkassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignmemberstoguardrailglobals.mdx b/docs/models/operations/bulkassignmemberstoguardrailglobals.mdx index 667555eb1..aa2863ddb 100644 --- a/docs/models/operations/bulkassignmemberstoguardrailglobals.mdx +++ b/docs/models/operations/bulkassignmemberstoguardrailglobals.mdx @@ -14,6 +14,6 @@ let value: BulkAssignMembersToGuardrailGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx index 9d61077f9..f7b277ce8 100644 --- a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx @@ -22,8 +22,8 @@ let value: BulkAssignMembersToGuardrailRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignMembersRequest` | [models.BulkAssignMembersRequest](../../models/bulkassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkAssignMembersRequest` | [models.BulkAssignMembersRequest](../../models/bulkassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkremoveworkspacemembersglobals.mdx b/docs/models/operations/bulkremoveworkspacemembersglobals.mdx index 229fa3709..121b2ede4 100644 --- a/docs/models/operations/bulkremoveworkspacemembersglobals.mdx +++ b/docs/models/operations/bulkremoveworkspacemembersglobals.mdx @@ -14,6 +14,6 @@ let value: BulkRemoveWorkspaceMembersGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx index 8e7fb4fca..72888589b 100644 --- a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx @@ -22,8 +22,8 @@ let value: BulkRemoveWorkspaceMembersRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkRemoveWorkspaceMembersRequest` | [models.BulkRemoveWorkspaceMembersRequest](../../models/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The workspace ID (UUID) or slug | production | +| `bulkRemoveWorkspaceMembersRequest` | [models.BulkRemoveWorkspaceMembersRequest](../../models/bulkremoveworkspacemembersrequest.mdx) | ✅ | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignkeysfromguardrailglobals.mdx b/docs/models/operations/bulkunassignkeysfromguardrailglobals.mdx index 14f17516d..ee0526f1d 100644 --- a/docs/models/operations/bulkunassignkeysfromguardrailglobals.mdx +++ b/docs/models/operations/bulkunassignkeysfromguardrailglobals.mdx @@ -14,6 +14,6 @@ let value: BulkUnassignKeysFromGuardrailGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx index 65af5d906..ad699f9f4 100644 --- a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx @@ -21,8 +21,8 @@ let value: BulkUnassignKeysFromGuardrailRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignKeysRequest` | [models.BulkUnassignKeysRequest](../../models/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkUnassignKeysRequest` | [models.BulkUnassignKeysRequest](../../models/bulkunassignkeysrequest.mdx) | ✅ | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignmembersfromguardrailglobals.mdx b/docs/models/operations/bulkunassignmembersfromguardrailglobals.mdx index e3de2b5d9..c5fca1efe 100644 --- a/docs/models/operations/bulkunassignmembersfromguardrailglobals.mdx +++ b/docs/models/operations/bulkunassignmembersfromguardrailglobals.mdx @@ -14,6 +14,6 @@ let value: BulkUnassignMembersFromGuardrailGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx index 17cfc9eac..752f94e3d 100644 --- a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx @@ -22,8 +22,8 @@ let value: BulkUnassignMembersFromGuardrailRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignMembersRequest` | [models.BulkUnassignMembersRequest](../../models/bulkunassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `bulkUnassignMembersRequest` | [models.BulkUnassignMembersRequest](../../models/bulkunassignmembersrequest.mdx) | ✅ | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/classifierdimensions.mdx b/docs/models/operations/classifierdimensions.mdx index 9ac97c3b3..83ab3e77d 100644 --- a/docs/models/operations/classifierdimensions.mdx +++ b/docs/models/operations/classifierdimensions.mdx @@ -18,6 +18,6 @@ let value: ClassifierDimensions = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `classifierId` | *string* | :heavy_check_mark: | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | -| `dimensionNames` | *string*[] | :heavy_minus_sign: | N/A | | -| `includeNulls` | *boolean* | :heavy_minus_sign: | When true, also include generations that have no tag from this classifier. Defaults to false, which returns only classified generations. | | \ No newline at end of file +| `classifierId` | *string* | ✅ | UUID of the classifier whose tags to group by. | 550e8400-e29b-41d4-a716-446655440000 | +| `dimensionNames` | *string*[] | ➖ | N/A | | +| `includeNulls` | *boolean* | ➖ | When true, also include generations that have no tag from this classifier. Defaults to false, which returns only classified generations. | | \ No newline at end of file diff --git a/docs/models/operations/classifierfilters.mdx b/docs/models/operations/classifierfilters.mdx index cb983c222..93ea59d60 100644 --- a/docs/models/operations/classifierfilters.mdx +++ b/docs/models/operations/classifierfilters.mdx @@ -19,5 +19,5 @@ let value: ClassifierFilters = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `classifierId` | *string* | :heavy_check_mark: | UUID of the classifier whose tags to filter by. Must match classifier_dimensions.classifier_id when both are specified. | 550e8400-e29b-41d4-a716-446655440000 | -| `filters` | [operations.ClassifierFiltersFilter](../../models/operations/classifierfiltersfilter.mdx)[] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `classifierId` | *string* | ✅ | UUID of the classifier whose tags to filter by. Must match classifier_dimensions.classifier_id when both are specified. | 550e8400-e29b-41d4-a716-446655440000 | +| `filters` | [operations.ClassifierFiltersFilter](../../models/operations/classifierfiltersfilter.mdx)[] | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/classifierfiltersfilter.mdx b/docs/models/operations/classifierfiltersfilter.mdx index bbd6d0751..aad2ec502 100644 --- a/docs/models/operations/classifierfiltersfilter.mdx +++ b/docs/models/operations/classifierfiltersfilter.mdx @@ -18,6 +18,6 @@ let value: ClassifierFiltersFilter = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field` | *string* | :heavy_check_mark: | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | -| `operator` | *string* | :heavy_check_mark: | Filter operator. Only equality/set operators are supported (eq, neq, in, not_in) — ordered comparisons are not available because classification values are strings. | eq | -| `value` | *operations.ClassifierFiltersValue* | :heavy_check_mark: | Filter value. Use a scalar (string or number) for eq/neq, or an array for in/not_in. | Engineering | \ No newline at end of file +| `field` | *string* | ✅ | Classifier dimension name to filter on (snake_case identifier, e.g. "department", "work_type"). | department | +| `operator` | *string* | ✅ | Filter operator. Only equality/set operators are supported (eq, neq, in, not_in) — ordered comparisons are not available because classification values are strings. | eq | +| `value` | *operations.ClassifierFiltersValue* | ✅ | Filter value. Use a scalar (string or number) for eq/neq, or an array for in/not_in. | Engineering | \ No newline at end of file diff --git a/docs/models/operations/contentimageurl.mdx b/docs/models/operations/contentimageurl.mdx index d5d371885..fa150592d 100644 --- a/docs/models/operations/contentimageurl.mdx +++ b/docs/models/operations/contentimageurl.mdx @@ -19,5 +19,5 @@ let value: ContentImageURL = { | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `imageUrl` | [operations.ImageUrl](../../models/operations/imageurl.mdx) | :heavy_check_mark: | N/A | -| `type` | *"image_url"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [operations.ImageUrl](../../models/operations/imageurl.mdx) | ✅ | N/A | +| `type` | *"image_url"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/contenttext.mdx b/docs/models/operations/contenttext.mdx index 3aad999fb..f7ad28784 100644 --- a/docs/models/operations/contenttext.mdx +++ b/docs/models/operations/contenttext.mdx @@ -17,5 +17,5 @@ let value: ContentText = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"text"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *string* | ✅ | N/A | +| `type` | *"text"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/copyvaultsecretstointernglobals.mdx b/docs/models/operations/copyvaultsecretstointernglobals.mdx index d0315df7b..3b11077a3 100644 --- a/docs/models/operations/copyvaultsecretstointernglobals.mdx +++ b/docs/models/operations/copyvaultsecretstointernglobals.mdx @@ -14,6 +14,6 @@ let value: CopyVaultSecretsToInternGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/copyvaultsecretstointernrequest.mdx b/docs/models/operations/copyvaultsecretstointernrequest.mdx index 2323cb94c..22b5d7b7c 100644 --- a/docs/models/operations/copyvaultsecretstointernrequest.mdx +++ b/docs/models/operations/copyvaultsecretstointernrequest.mdx @@ -21,8 +21,8 @@ let value: CopyVaultSecretsToInternRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `vaultSecretCopyRequest` | [models.VaultSecretCopyRequest](../../models/vaultsecretcopyrequest.mdx) | :heavy_check_mark: | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `vaultSecretCopyRequest` | [models.VaultSecretCopyRequest](../../models/vaultsecretcopyrequest.mdx) | ✅ | N/A | \{
"names": [
"github_token"
]
} | \ No newline at end of file diff --git a/docs/models/operations/createapialphadecisionsglobals.mdx b/docs/models/operations/createapialphadecisionsglobals.mdx index 64ad42635..a639046f1 100644 --- a/docs/models/operations/createapialphadecisionsglobals.mdx +++ b/docs/models/operations/createapialphadecisionsglobals.mdx @@ -14,6 +14,6 @@ let value: CreateApiAlphaDecisionsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createapialphadecisionsrequest.mdx b/docs/models/operations/createapialphadecisionsrequest.mdx index 03b76da11..d93118435 100644 --- a/docs/models/operations/createapialphadecisionsrequest.mdx +++ b/docs/models/operations/createapialphadecisionsrequest.mdx @@ -20,7 +20,7 @@ let value: CreateApiAlphaDecisionsRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `decisionsRequest` | [models.DecisionsRequest](../../models/decisionsrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `decisionsRequest` | [models.DecisionsRequest](../../models/decisionsrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/createaudiospeechglobals.mdx b/docs/models/operations/createaudiospeechglobals.mdx index 8b0963ab8..0a195ff73 100644 --- a/docs/models/operations/createaudiospeechglobals.mdx +++ b/docs/models/operations/createaudiospeechglobals.mdx @@ -14,6 +14,6 @@ let value: CreateAudioSpeechGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createaudiospeechrequest.mdx b/docs/models/operations/createaudiospeechrequest.mdx index b76efbcbf..bb226d59d 100644 --- a/docs/models/operations/createaudiospeechrequest.mdx +++ b/docs/models/operations/createaudiospeechrequest.mdx @@ -19,7 +19,7 @@ let value: CreateAudioSpeechRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `speechRequest` | [models.SpeechRequest](../../models/speechrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": "Hello world",
"model": "mistralai/voxtral-mini-tts-2603",
"response_format": "pcm",
"speed": 1,
"voice": "en_paul_neutral"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `speechRequest` | [models.SpeechRequest](../../models/speechrequest.mdx) | ✅ | N/A | \{
"input": "Hello world",
"model": "mistralai/voxtral-mini-tts-2603",
"response_format": "pcm",
"speed": 1,
"voice": "en_paul_neutral"
} | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsglobals.mdx b/docs/models/operations/createaudiotranscriptionsglobals.mdx index 2bd30aaeb..a6a472c5f 100644 --- a/docs/models/operations/createaudiotranscriptionsglobals.mdx +++ b/docs/models/operations/createaudiotranscriptionsglobals.mdx @@ -14,6 +14,6 @@ let value: CreateAudioTranscriptionsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx b/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx index b1938e042..8d77ffd10 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartfile.mdx @@ -14,5 +14,5 @@ import { CreateAudioTranscriptionsMultipartFile } from "@openrouter/sdk/models/o | Field | Type | Required | Description | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `fileName` | *string* | :heavy_check_mark: | N/A | -| `content` | *ReadableStream\* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileName` | *string* | ✅ | N/A | +| `content` | *ReadableStream\* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartglobals.mdx b/docs/models/operations/createaudiotranscriptionsmultipartglobals.mdx index db91edec9..c296a774f 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartglobals.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartglobals.mdx @@ -14,6 +14,6 @@ let value: CreateAudioTranscriptionsMultipartGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx index e08cabe88..03be6eca1 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx @@ -14,7 +14,7 @@ import { CreateAudioTranscriptionsMultipartRequest } from "@openrouter/sdk/model | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `requestBody` | [operations.CreateAudioTranscriptionsMultipartRequestBody](../../models/operations/createaudiotranscriptionsmultipartrequestbody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `requestBody` | [operations.CreateAudioTranscriptionsMultipartRequestBody](../../models/operations/createaudiotranscriptionsmultipartrequestbody.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartrequestbody.mdx b/docs/models/operations/createaudiotranscriptionsmultipartrequestbody.mdx index 088215898..f74a5fe91 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartrequestbody.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartrequestbody.mdx @@ -14,16 +14,16 @@ import { CreateAudioTranscriptionsMultipartRequestBody } from "@openrouter/sdk/m | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `diarize` | *boolean* | :heavy_minus_sign: | Label each word with the speaker who said it (words[].speaker, words[].speaker_label). Requires response_format "verbose_json" (400 otherwise); word timestamps are included even when timestamp_granularities[] omits "word". Only supported by some providers; 400 when the selected model cannot diarize. | -| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile.mdx) | :heavy_minus_sign: | The audio file to transcribe. The format is derived from the filename extension or the file part content type. Max 25 MB; send larger files as base64 JSON via input_audio, or by URL via source_url. Exactly one of file or source_url is required. | -| `keyterms` | *string*[] | :heavy_minus_sign: | Domain terms, names, or phrases to bias recognition toward; repeat the part once per term (keyterms=... is also accepted). Only supported by some providers; 400 when the selected model cannot use keyterms. | -| `language` | *string* | :heavy_minus_sign: | The language of the input audio (ISO-639-1). | -| `model` | *string* | :heavy_check_mark: | The model to use for transcription. | -| `provider` | *string* | :heavy_minus_sign: | JSON-encoded provider preferences object, the same shape as the JSON body field: \{ "zdr": true, "data_collection": "deny", "options": \{ "\": \{ ... } } }. Only options for the matched provider are forwarded. Must decode to a JSON object. | -| `responseFormat` | [operations.ResponseFormat](../../models/operations/responseformat.mdx) | :heavy_minus_sign: | The response format. "json" (default) returns \{ text, usage }; "verbose_json" additionally returns task, language, duration, and segment-level timestamps (OpenAI-compatible providers only). | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. | -| `sourceUrl` | *string* | :heavy_minus_sign: | Publicly reachable http(s) URL of the audio file, downloaded by the provider directly (no size limit on our side). The format is derived from the URL path extension. Only supported by some providers; exactly one of file or source_url is required. | -| `temperature` | *number* | :heavy_minus_sign: | The sampling temperature. | -| `timestampGranularities` | [operations.TimestampGranularities](../../models/operations/timestampgranularities.mdx)[] | :heavy_minus_sign: | Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array. | -| `trace` | *string* | :heavy_minus_sign: | JSON-encoded trace metadata object (trace_id, trace_name, span_name, generation_name, parent_span_id and custom keys) attached to the Broadcast trace. Must decode to a JSON object. | -| `user` | *string* | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | \ No newline at end of file +| `diarize` | *boolean* | ➖ | Label each word with the speaker who said it (words[].speaker, words[].speaker_label). Requires response_format "verbose_json" (400 otherwise); word timestamps are included even when timestamp_granularities[] omits "word". Only supported by some providers; 400 when the selected model cannot diarize. | +| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile.mdx) | ➖ | The audio file to transcribe. The format is derived from the filename extension or the file part content type. Max 25 MB; send larger files as base64 JSON via input_audio, or by URL via source_url. Exactly one of file or source_url is required. | +| `keyterms` | *string*[] | ➖ | Domain terms, names, or phrases to bias recognition toward; repeat the part once per term (keyterms=... is also accepted). Only supported by some providers; 400 when the selected model cannot use keyterms. | +| `language` | *string* | ➖ | The language of the input audio (ISO-639-1). | +| `model` | *string* | ✅ | The model to use for transcription. | +| `provider` | *string* | ➖ | JSON-encoded provider preferences object, the same shape as the JSON body field: \{ "zdr": true, "data_collection": "deny", "options": \{ "\": \{ ... } } }. Only options for the matched provider are forwarded. Must decode to a JSON object. | +| `responseFormat` | [operations.ResponseFormat](../../models/operations/responseformat.mdx) | ➖ | The response format. "json" (default) returns \{ text, usage }; "verbose_json" additionally returns task, language, duration, and segment-level timestamps (OpenAI-compatible providers only). | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. | +| `sourceUrl` | *string* | ➖ | Publicly reachable http(s) URL of the audio file, downloaded by the provider directly (no size limit on our side). The format is derived from the URL path extension. Only supported by some providers; exactly one of file or source_url is required. | +| `temperature` | *number* | ➖ | The sampling temperature. | +| `timestampGranularities` | [operations.TimestampGranularities](../../models/operations/timestampgranularities.mdx)[] | ➖ | Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array. | +| `trace` | *string* | ➖ | JSON-encoded trace metadata object (trace_id, trace_name, span_name, generation_name, parent_span_id and custom keys) attached to the Broadcast trace. Must decode to a JSON object. | +| `user` | *string* | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsrequest.mdx b/docs/models/operations/createaudiotranscriptionsrequest.mdx index 5c888d9ba..bb7b4cd12 100644 --- a/docs/models/operations/createaudiotranscriptionsrequest.mdx +++ b/docs/models/operations/createaudiotranscriptionsrequest.mdx @@ -22,7 +22,7 @@ let value: CreateAudioTranscriptionsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `sttRequest` | [models.STTRequest](../../models/sttrequest.mdx) | :heavy_check_mark: | N/A | \{
"input_audio": \{
"data": "UklGRiQA...",
"format": "wav"
},
"language": "en",
"model": "openai/whisper-large-v3"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `sttRequest` | [models.STTRequest](../../models/sttrequest.mdx) | ✅ | N/A | \{
"input_audio": \{
"data": "UklGRiQA...",
"format": "wav"
},
"language": "en",
"model": "openai/whisper-large-v3"
} | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscodedata.mdx b/docs/models/operations/createauthkeyscodedata.mdx index 2460572e1..6fc7bace6 100644 --- a/docs/models/operations/createauthkeyscodedata.mdx +++ b/docs/models/operations/createauthkeyscodedata.mdx @@ -20,6 +20,6 @@ let value: CreateAuthKeysCodeData = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `appId` | *number* | :heavy_check_mark: | The application ID associated with this auth code | 12345 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | -| `id` | *string* | :heavy_check_mark: | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file +| `appId` | *number* | ✅ | The application ID associated with this auth code | 12345 | +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the auth code was created | 2025-08-24T10:30:00Z | +| `id` | *string* | ✅ | The authorization code ID to use in the exchange request | auth_code_xyz789 | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscodeglobals.mdx b/docs/models/operations/createauthkeyscodeglobals.mdx index 17201c291..bc5ca0140 100644 --- a/docs/models/operations/createauthkeyscodeglobals.mdx +++ b/docs/models/operations/createauthkeyscodeglobals.mdx @@ -14,6 +14,6 @@ let value: CreateAuthKeysCodeGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscoderequest.mdx b/docs/models/operations/createauthkeyscoderequest.mdx index 39755411d..11f1efd97 100644 --- a/docs/models/operations/createauthkeyscoderequest.mdx +++ b/docs/models/operations/createauthkeyscoderequest.mdx @@ -18,7 +18,7 @@ let value: CreateAuthKeysCodeRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateAuthKeysCodeRequestBody](../../models/operations/createauthkeyscoderequestbody.mdx) | :heavy_check_mark: | N/A | \{
"callback_url": "https://myapp.com/auth/callback",
"code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM",
"code_challenge_method": "S256",
"limit": 100
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `requestBody` | [operations.CreateAuthKeysCodeRequestBody](../../models/operations/createauthkeyscoderequestbody.mdx) | ✅ | N/A | \{
"callback_url": "https://myapp.com/auth/callback",
"code_challenge": "E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM",
"code_challenge_method": "S256",
"limit": 100
} | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscoderequestbody.mdx b/docs/models/operations/createauthkeyscoderequestbody.mdx index e911c7440..d993c6606 100644 --- a/docs/models/operations/createauthkeyscoderequestbody.mdx +++ b/docs/models/operations/createauthkeyscoderequestbody.mdx @@ -16,11 +16,11 @@ let value: CreateAuthKeysCodeRequestBody = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `callbackUrl` | *string* | :heavy_check_mark: | The callback URL to redirect to after authorization. Supports https URLs and localhost/127.0.0.1 URLs on any port for local CLI tools. | https://myapp.com/auth/callback | -| `codeChallenge` | *string* | :heavy_minus_sign: | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | -| `codeChallengeMethod` | [operations.CreateAuthKeysCodeCodeChallengeMethod](../../models/operations/createauthkeyscodecodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | -| `keyLabel` | *string* | :heavy_minus_sign: | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | -| `limit` | *number* | :heavy_minus_sign: | Credit limit for the API key to be created | 100 | -| `usageLimitType` | [operations.UsageLimitType](../../models/operations/usagelimittype.mdx) | :heavy_minus_sign: | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | -| `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID to associate the API key with | | \ No newline at end of file +| `callbackUrl` | *string* | ✅ | The callback URL to redirect to after authorization. Supports https URLs and localhost/127.0.0.1 URLs on any port for local CLI tools. | https://myapp.com/auth/callback | +| `codeChallenge` | *string* | ➖ | PKCE code challenge for enhanced security | E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM | +| `codeChallengeMethod` | [operations.CreateAuthKeysCodeCodeChallengeMethod](../../models/operations/createauthkeyscodecodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | +| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ➖ | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | +| `keyLabel` | *string* | ➖ | Optional custom label for the API key. Defaults to the app name if not provided. | My Custom Key | +| `limit` | *number* | ➖ | Credit limit for the API key to be created | 100 | +| `usageLimitType` | [operations.UsageLimitType](../../models/operations/usagelimittype.mdx) | ➖ | Optional credit limit reset interval. When set, the credit limit resets on this interval. | monthly | +| `workspaceId` | *string* | ➖ | Optional workspace ID to associate the API key with | | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscoderesponse.mdx b/docs/models/operations/createauthkeyscoderesponse.mdx index 789491e61..1ea4cd649 100644 --- a/docs/models/operations/createauthkeyscoderesponse.mdx +++ b/docs/models/operations/createauthkeyscoderesponse.mdx @@ -22,4 +22,4 @@ let value: CreateAuthKeysCodeResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [operations.CreateAuthKeysCodeData](../../models/operations/createauthkeyscodedata.mdx) | :heavy_check_mark: | Auth code data | \{
"app_id": 12345,
"created_at": "2025-08-24T10:30:00Z",
"id": "auth_code_xyz789"
} | \ No newline at end of file +| `data` | [operations.CreateAuthKeysCodeData](../../models/operations/createauthkeyscodedata.mdx) | ✅ | Auth code data | \{
"app_id": 12345,
"created_at": "2025-08-24T10:30:00Z",
"id": "auth_code_xyz789"
} | \ No newline at end of file diff --git a/docs/models/operations/createbatchesglobals.mdx b/docs/models/operations/createbatchesglobals.mdx index 6dd5e63f6..52e79de21 100644 --- a/docs/models/operations/createbatchesglobals.mdx +++ b/docs/models/operations/createbatchesglobals.mdx @@ -14,6 +14,6 @@ let value: CreateBatchesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createbatchesrequest.mdx b/docs/models/operations/createbatchesrequest.mdx index 2fb4addfa..37eb6f786 100644 --- a/docs/models/operations/createbatchesrequest.mdx +++ b/docs/models/operations/createbatchesrequest.mdx @@ -20,7 +20,7 @@ let value: CreateBatchesRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `batchSubmitBody` | [models.BatchSubmitBody](../../models/batchsubmitbody.mdx) | :heavy_check_mark: | The batch to create. Each item in `requests` has a unique `custom_id` and a `body` in the request format of the chosen `endpoint`. | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `batchSubmitBody` | [models.BatchSubmitBody](../../models/batchsubmitbody.mdx) | ✅ | The batch to create. Each item in `requests` has a unique `custom_id` and a `body` in the request format of the chosen `endpoint`. | \ No newline at end of file diff --git a/docs/models/operations/createbyokkeyglobals.mdx b/docs/models/operations/createbyokkeyglobals.mdx index 6d8e67a8f..7fa88b108 100644 --- a/docs/models/operations/createbyokkeyglobals.mdx +++ b/docs/models/operations/createbyokkeyglobals.mdx @@ -14,6 +14,6 @@ let value: CreateBYOKKeyGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createbyokkeyrequest.mdx b/docs/models/operations/createbyokkeyrequest.mdx index 2416ec001..5f61edb81 100644 --- a/docs/models/operations/createbyokkeyrequest.mdx +++ b/docs/models/operations/createbyokkeyrequest.mdx @@ -19,7 +19,7 @@ let value: CreateBYOKKeyRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createBYOKKeyRequest` | [models.CreateBYOKKeyRequest](../../models/createbyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"key": "sk-proj-abc123...",
"name": "Production OpenAI Key",
"provider": "openai"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `createBYOKKeyRequest` | [models.CreateBYOKKeyRequest](../../models/createbyokkeyrequest.mdx) | ✅ | N/A | \{
"key": "sk-proj-abc123...",
"name": "Production OpenAI Key",
"provider": "openai"
} | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsdata.mdx b/docs/models/operations/createembeddingsdata.mdx index bbbb459ab..510f90bdd 100644 --- a/docs/models/operations/createembeddingsdata.mdx +++ b/docs/models/operations/createembeddingsdata.mdx @@ -23,6 +23,6 @@ let value: CreateEmbeddingsData = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `embedding` | *operations.Embedding* | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | -| `index` | *number* | :heavy_minus_sign: | Index of the embedding in the input list | 0 | -| `object` | [operations.ObjectEmbedding](../../models/operations/objectembedding.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `embedding` | *operations.Embedding* | ✅ | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `index` | *number* | ➖ | Index of the embedding in the input list | 0 | +| `object` | [operations.ObjectEmbedding](../../models/operations/objectembedding.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsglobals.mdx b/docs/models/operations/createembeddingsglobals.mdx index 26a77f0ed..67eb7e230 100644 --- a/docs/models/operations/createembeddingsglobals.mdx +++ b/docs/models/operations/createembeddingsglobals.mdx @@ -14,6 +14,6 @@ let value: CreateEmbeddingsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createembeddingsrequest.mdx b/docs/models/operations/createembeddingsrequest.mdx index 57829559d..6f36bc36f 100644 --- a/docs/models/operations/createembeddingsrequest.mdx +++ b/docs/models/operations/createembeddingsrequest.mdx @@ -19,7 +19,7 @@ let value: CreateEmbeddingsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateEmbeddingsRequestBody](../../models/operations/createembeddingsrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"dimensions": 1536,
"input": "The quick brown fox jumps over the lazy dog",
"model": "openai/text-embedding-3-small"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `requestBody` | [operations.CreateEmbeddingsRequestBody](../../models/operations/createembeddingsrequestbody.mdx) | ✅ | N/A | \{
"dimensions": 1536,
"input": "The quick brown fox jumps over the lazy dog",
"model": "openai/text-embedding-3-small"
} | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsrequestbody.mdx b/docs/models/operations/createembeddingsrequestbody.mdx index 81b8f7ab7..60e674061 100644 --- a/docs/models/operations/createembeddingsrequestbody.mdx +++ b/docs/models/operations/createembeddingsrequestbody.mdx @@ -19,12 +19,12 @@ let value: CreateEmbeddingsRequestBody = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dimensions` | *number* | :heavy_minus_sign: | The number of dimensions for the output embeddings | 1536 | -| `encodingFormat` | [operations.EncodingFormat](../../models/operations/encodingformat.mdx) | :heavy_minus_sign: | The format of the output embeddings | float | -| `input` | *operations.InputUnion* | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | -| `inputType` | *string* | :heavy_minus_sign: | The type of input (e.g. search_query, search_document) | search_query | -| `model` | *string* | :heavy_check_mark: | The model to use for embeddings | openai/text-embedding-3-small | -| `provider` | [models.ProviderPreferences](../../models/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `trace` | [models.TraceConfig](../../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `user` | *string* | :heavy_minus_sign: | A unique identifier for the end-user | user-1234 | \ No newline at end of file +| `dimensions` | *number* | ➖ | The number of dimensions for the output embeddings | 1536 | +| `encodingFormat` | [operations.EncodingFormat](../../models/operations/encodingformat.mdx) | ➖ | The format of the output embeddings | float | +| `input` | *operations.InputUnion* | ✅ | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | +| `inputType` | *string* | ➖ | The type of input (e.g. search_query, search_document) | search_query | +| `model` | *string* | ✅ | The model to use for embeddings | openai/text-embedding-3-small | +| `provider` | [models.ProviderPreferences](../../models/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `trace` | [models.TraceConfig](../../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `user` | *string* | ➖ | A unique identifier for the end-user | user-1234 | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsresponsebody.mdx b/docs/models/operations/createembeddingsresponsebody.mdx index 594734d20..9bb0cbc94 100644 --- a/docs/models/operations/createembeddingsresponsebody.mdx +++ b/docs/models/operations/createembeddingsresponsebody.mdx @@ -29,8 +29,8 @@ let value: CreateEmbeddingsResponseBody = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateEmbeddingsData](../../models/operations/createembeddingsdata.mdx)[] | :heavy_check_mark: | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | -| `id` | *string* | :heavy_minus_sign: | Unique identifier for the embeddings response | embd-1234567890 | -| `model` | *string* | :heavy_check_mark: | The model used for embeddings | openai/text-embedding-3-small | -| `object` | [operations.ObjectT](../../models/operations/objectt.mdx) | :heavy_check_mark: | N/A | | -| `usage` | [operations.CreateEmbeddingsUsage](../../models/operations/createembeddingsusage.mdx) | :heavy_minus_sign: | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file +| `data` | [operations.CreateEmbeddingsData](../../models/operations/createembeddingsdata.mdx)[] | ✅ | List of embedding objects | [
\{
"embedding": [
0.0023064255,
-0.009327292,
0.015797347
],
"index": 0,
"object": "embedding"
}
] | +| `id` | *string* | ➖ | Unique identifier for the embeddings response | embd-1234567890 | +| `model` | *string* | ✅ | The model used for embeddings | openai/text-embedding-3-small | +| `object` | [operations.ObjectT](../../models/operations/objectt.mdx) | ✅ | N/A | | +| `usage` | [operations.CreateEmbeddingsUsage](../../models/operations/createembeddingsusage.mdx) | ➖ | Token usage statistics | \{
"prompt_tokens": 8,
"total_tokens": 8
} | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsusage.mdx b/docs/models/operations/createembeddingsusage.mdx index 518b2109c..9caafcda9 100644 --- a/docs/models/operations/createembeddingsusage.mdx +++ b/docs/models/operations/createembeddingsusage.mdx @@ -19,9 +19,9 @@ let value: CreateEmbeddingsUsage = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cost` | *number* | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `costDetails` | [models.CostDetails](../../models/costdetails.mdx) | :heavy_minus_sign: | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `promptTokens` | *number* | :heavy_check_mark: | Number of tokens in the input | 8 | -| `promptTokensDetails` | [operations.PromptTokensDetails](../../models/operations/prompttokensdetails.mdx) | :heavy_minus_sign: | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | -| `totalTokens` | *number* | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file +| `cost` | *number* | ➖ | Cost of the request in credits | 0.0001 | +| `costDetails` | [models.CostDetails](../../models/costdetails.mdx) | ➖ | Breakdown of upstream inference costs | \{
"upstream_inference_completions_cost": 0.0004,
"upstream_inference_cost": null,
"upstream_inference_prompt_cost": 0.0008
} | +| `isByok` | *boolean* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `promptTokens` | *number* | ✅ | Number of tokens in the input | 8 | +| `promptTokensDetails` | [operations.PromptTokensDetails](../../models/operations/prompttokensdetails.mdx) | ➖ | Per-modality token breakdown. Only present when the input contains 2+ modalities (e.g. text + image) and the upstream provider returns modality-level usage data. Only non-zero modality counts are included. | | +| `totalTokens` | *number* | ✅ | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/models/operations/createenduserglobals.mdx b/docs/models/operations/createenduserglobals.mdx index 1590d5b98..9aa0aa355 100644 --- a/docs/models/operations/createenduserglobals.mdx +++ b/docs/models/operations/createenduserglobals.mdx @@ -14,6 +14,6 @@ let value: CreateEndUserGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createenduserrequest.mdx b/docs/models/operations/createenduserrequest.mdx index efcbc7ce2..152dbff82 100644 --- a/docs/models/operations/createenduserrequest.mdx +++ b/docs/models/operations/createenduserrequest.mdx @@ -18,7 +18,7 @@ let value: CreateEndUserRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createEndUserRequest` | [models.CreateEndUserRequest](../../models/createenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"user": "employee_123"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `createEndUserRequest` | [models.CreateEndUserRequest](../../models/createenduserrequest.mdx) | ✅ | N/A | \{
"user": "employee_123"
} | \ No newline at end of file diff --git a/docs/models/operations/createguardrailglobals.mdx b/docs/models/operations/createguardrailglobals.mdx index ddb7932ce..a6a21bf3e 100644 --- a/docs/models/operations/createguardrailglobals.mdx +++ b/docs/models/operations/createguardrailglobals.mdx @@ -14,6 +14,6 @@ let value: CreateGuardrailGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createguardrailrequest.mdx b/docs/models/operations/createguardrailrequest.mdx index a06bc9a53..f340e07ae 100644 --- a/docs/models/operations/createguardrailrequest.mdx +++ b/docs/models/operations/createguardrailrequest.mdx @@ -18,7 +18,7 @@ let value: CreateGuardrailRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createGuardrailRequest` | [models.CreateGuardrailRequest](../../models/createguardrailrequest.mdx) | :heavy_check_mark: | N/A | \{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"deepseek"
],
"content_filter_builtins": [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
],
"content_filters": null,
"description": "A guardrail for limiting API usage",
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"ignored_models": null,
"ignored_providers": null,
"limit_usd": 50,
"name": "My New Guardrail",
"reset_interval": "monthly"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `createGuardrailRequest` | [models.CreateGuardrailRequest](../../models/createguardrailrequest.mdx) | ✅ | N/A | \{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"deepseek"
],
"content_filter_builtins": [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
],
"content_filters": null,
"description": "A guardrail for limiting API usage",
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"ignored_models": null,
"ignored_providers": null,
"limit_usd": 50,
"name": "My New Guardrail",
"reset_interval": "monthly"
} | \ No newline at end of file diff --git a/docs/models/operations/createimagesglobals.mdx b/docs/models/operations/createimagesglobals.mdx index 60afb9437..4a72a076b 100644 --- a/docs/models/operations/createimagesglobals.mdx +++ b/docs/models/operations/createimagesglobals.mdx @@ -14,6 +14,6 @@ let value: CreateImagesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createimagesrequest.mdx b/docs/models/operations/createimagesrequest.mdx index a793792ee..d9d687fff 100644 --- a/docs/models/operations/createimagesrequest.mdx +++ b/docs/models/operations/createimagesrequest.mdx @@ -19,7 +19,7 @@ let value: CreateImagesRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `imageGenerationRequest` | [models.ImageGenerationRequest](../../models/imagegenerationrequest.mdx) | :heavy_check_mark: | N/A | \{
"model": "bytedance-seed/seedream-4.5",
"prompt": "a red panda astronaut floating in space, studio lighting"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `imageGenerationRequest` | [models.ImageGenerationRequest](../../models/imagegenerationrequest.mdx) | ✅ | N/A | \{
"model": "bytedance-seed/seedream-4.5",
"prompt": "a red panda astronaut floating in space, studio lighting"
} | \ No newline at end of file diff --git a/docs/models/operations/createinternchatcompletionglobals.mdx b/docs/models/operations/createinternchatcompletionglobals.mdx index 45ef7d6e1..cca17cbb6 100644 --- a/docs/models/operations/createinternchatcompletionglobals.mdx +++ b/docs/models/operations/createinternchatcompletionglobals.mdx @@ -14,6 +14,6 @@ let value: CreateInternChatCompletionGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createinternchatcompletionrequest.mdx b/docs/models/operations/createinternchatcompletionrequest.mdx index 239255eac..6a7fe1557 100644 --- a/docs/models/operations/createinternchatcompletionrequest.mdx +++ b/docs/models/operations/createinternchatcompletionrequest.mdx @@ -25,8 +25,8 @@ let value: CreateInternChatCompletionRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | -| `internChatCompletionRequest` | [models.InternChatCompletionRequest](../../models/internchatcompletionrequest.mdx) | :heavy_check_mark: | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | The intern to talk to. | a11e0000-0000-4000-8000-000000000005 | +| `internChatCompletionRequest` | [models.InternChatCompletionRequest](../../models/internchatcompletionrequest.mdx) | ✅ | N/A | \{
"approval_mode": "manual",
"messages": [
\{
"content": "Summarize the open pull requests.",
"role": "user"
}
],
"stream": true
} | \ No newline at end of file diff --git a/docs/models/operations/createinternchatcompletionresponse.mdx b/docs/models/operations/createinternchatcompletionresponse.mdx index 7b69fef8c..26dd04068 100644 --- a/docs/models/operations/createinternchatcompletionresponse.mdx +++ b/docs/models/operations/createinternchatcompletionresponse.mdx @@ -14,5 +14,5 @@ import { CreateInternChatCompletionResponse } from "@openrouter/sdk/models/opera | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `headers` | Record\ | :heavy_check_mark: | N/A | -| `result` | *operations.CreateInternChatCompletionResponseResult* | :heavy_check_mark: | N/A | \ No newline at end of file +| `headers` | Record\ | ✅ | N/A | +| `result` | *operations.CreateInternChatCompletionResponseResult* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/createinternglobals.mdx b/docs/models/operations/createinternglobals.mdx index d5daed778..e7525fe98 100644 --- a/docs/models/operations/createinternglobals.mdx +++ b/docs/models/operations/createinternglobals.mdx @@ -14,6 +14,6 @@ let value: CreateInternGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createinternrequest.mdx b/docs/models/operations/createinternrequest.mdx index 01167c665..4d88ef119 100644 --- a/docs/models/operations/createinternrequest.mdx +++ b/docs/models/operations/createinternrequest.mdx @@ -19,8 +19,8 @@ let value: CreateInternRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotencyKey` | *string* | :heavy_minus_sign: | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | -| `createInternRequest` | [models.CreateInternRequest](../../models/createinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotencyKey` | *string* | ➖ | Key that makes retries resume the same create operation, from 1 through 255 characters. An empty or longer key is refused with 400. Without the header, the server derives a stable key from the request body. | create-research-assistant-2026-09-16 | +| `createInternRequest` | [models.CreateInternRequest](../../models/createinternrequest.mdx) | ✅ | N/A | \{
"name": "research-assistant",
"provision": true,
"workspace_id": "89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb"
} | \ No newline at end of file diff --git a/docs/models/operations/createkeysdata.mdx b/docs/models/operations/createkeysdata.mdx index 775e56bd9..195a4f48d 100644 --- a/docs/models/operations/createkeysdata.mdx +++ b/docs/models/operations/createkeysdata.mdx @@ -39,26 +39,26 @@ let value: CreateKeysData = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `externalUser` | *string* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `lastUsedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byokUsage` | *number* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byokUsageDaily` | *number* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byokUsageMonthly` | *number* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byokUsageWeekly` | *number* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creatorUserId` | *string* | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `disabled` | *boolean* | ✅ | Whether the API key is disabled | false | +| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `externalUser` | *string* | ✅ | Partner's end-user identifier used for attribution. | null | +| `hash` | *string* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `includeByokInLimit` | *boolean* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `label` | *string* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `lastUsedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `limit` | *number* | ✅ | Spending limit for the API key in USD | 100 | +| `limitRemaining` | *number* | ✅ | Remaining spending limit in USD | 74.5 | +| `limitReset` | *string* | ✅ | Type of limit reset for the API key | monthly | +| `name` | *string* | ✅ | Name of the API key | My Production Key | +| `updatedAt` | *string* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *number* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usageDaily` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usageMonthly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usageWeekly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspaceId` | *string* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/createkeysglobals.mdx b/docs/models/operations/createkeysglobals.mdx index 69d8136cc..20f3c6f4f 100644 --- a/docs/models/operations/createkeysglobals.mdx +++ b/docs/models/operations/createkeysglobals.mdx @@ -14,6 +14,6 @@ let value: CreateKeysGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createkeysrequest.mdx b/docs/models/operations/createkeysrequest.mdx index 45a9a6b95..a47c2d7f6 100644 --- a/docs/models/operations/createkeysrequest.mdx +++ b/docs/models/operations/createkeysrequest.mdx @@ -18,7 +18,7 @@ let value: CreateKeysRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateKeysRequestBody](../../models/operations/createkeysrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"expires_at": "2027-12-31T23:59:59Z",
"include_byok_in_limit": true,
"limit": 50,
"limit_reset": "monthly",
"name": "My New API Key"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `requestBody` | [operations.CreateKeysRequestBody](../../models/operations/createkeysrequestbody.mdx) | ✅ | N/A | \{
"expires_at": "2027-12-31T23:59:59Z",
"include_byok_in_limit": true,
"limit": 50,
"limit_reset": "monthly",
"name": "My New API Key"
} | \ No newline at end of file diff --git a/docs/models/operations/createkeysrequestbody.mdx b/docs/models/operations/createkeysrequestbody.mdx index d6777181f..04ffabd4b 100644 --- a/docs/models/operations/createkeysrequestbody.mdx +++ b/docs/models/operations/createkeysrequestbody.mdx @@ -16,11 +16,11 @@ let value: CreateKeysRequestBody = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `creatorUserId` | *string* | :heavy_minus_sign: | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | -| `external` | [operations.External](../../models/operations/external.mdx) | :heavy_minus_sign: | Optional partner-defined identity associated with the created API key. | | -| `includeByokInLimit` | *boolean* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *number* | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `limitReset` | [operations.CreateKeysLimitReset](../../models/operations/createkeyslimitreset.mdx) | :heavy_minus_sign: | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | -| `name` | *string* | :heavy_check_mark: | Name for the new API key | My New API Key | -| `workspaceId` | *string* | :heavy_minus_sign: | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `creatorUserId` | *string* | ➖ | Optional user ID of the key creator. Only meaningful for organization-owned keys where a specific member is creating the key. | user_2dHFtVWx2n56w6HkM0000000000 | +| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ➖ | Optional ISO 8601 UTC expiration timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | +| `external` | [operations.External](../../models/operations/external.mdx) | ➖ | Optional partner-defined identity associated with the created API key. | | +| `includeByokInLimit` | *boolean* | ➖ | Whether to include BYOK usage in the limit | true | +| `limit` | *number* | ➖ | Optional spending limit for the API key in USD | 50 | +| `limitReset` | [operations.CreateKeysLimitReset](../../models/operations/createkeyslimitreset.mdx) | ➖ | Type of limit reset for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | monthly | +| `name` | *string* | ✅ | Name for the new API key | My New API Key | +| `workspaceId` | *string* | ➖ | The workspace to create the API key in. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/createkeysresponse.mdx b/docs/models/operations/createkeysresponse.mdx index 8dca66e9b..058b3ae57 100644 --- a/docs/models/operations/createkeysresponse.mdx +++ b/docs/models/operations/createkeysresponse.mdx @@ -43,5 +43,5 @@ let value: CreateKeysResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.CreateKeysData](../../models/operations/createkeysdata.mdx) | :heavy_check_mark: | The created API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | -| `key` | *string* | :heavy_check_mark: | The actual API key string (only shown once) | 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 | \ No newline at end of file +| `data` | [operations.CreateKeysData](../../models/operations/createkeysdata.mdx) | ✅ | The created API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | +| `key` | *string* | ✅ | The actual API key string (only shown once) | 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 | \ No newline at end of file diff --git a/docs/models/operations/createoauthtokenglobals.mdx b/docs/models/operations/createoauthtokenglobals.mdx index 9b2e273d6..1e519a983 100644 --- a/docs/models/operations/createoauthtokenglobals.mdx +++ b/docs/models/operations/createoauthtokenglobals.mdx @@ -14,6 +14,6 @@ let value: CreateOauthTokenGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createoauthtokenrequest.mdx b/docs/models/operations/createoauthtokenrequest.mdx index f11038e8c..0824a7ec8 100644 --- a/docs/models/operations/createoauthtokenrequest.mdx +++ b/docs/models/operations/createoauthtokenrequest.mdx @@ -21,7 +21,7 @@ let value: CreateOauthTokenRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `tokenExchangeRequest` | [models.TokenExchangeRequest](../../models/tokenexchangerequest.mdx) | :heavy_check_mark: | N/A | \{
"federation_policy_id": "4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b",
"grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
"subject_token": "\u003cjwt from your identity provider\u003e",
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `tokenExchangeRequest` | [models.TokenExchangeRequest](../../models/tokenexchangerequest.mdx) | ✅ | N/A | \{
"federation_policy_id": "4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b",
"grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
"subject_token": "\u003cjwt from your identity provider\u003e",
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt"
} | \ No newline at end of file diff --git a/docs/models/operations/createobservabilitydestinationglobals.mdx b/docs/models/operations/createobservabilitydestinationglobals.mdx index cc9c819f3..afc64f023 100644 --- a/docs/models/operations/createobservabilitydestinationglobals.mdx +++ b/docs/models/operations/createobservabilitydestinationglobals.mdx @@ -14,6 +14,6 @@ let value: CreateObservabilityDestinationGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createobservabilitydestinationrequest.mdx b/docs/models/operations/createobservabilitydestinationrequest.mdx index c3a6cae27..01e9a5664 100644 --- a/docs/models/operations/createobservabilitydestinationrequest.mdx +++ b/docs/models/operations/createobservabilitydestinationrequest.mdx @@ -24,7 +24,7 @@ let value: CreateObservabilityDestinationRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createObservabilityDestinationRequest` | [models.CreateObservabilityDestinationRequest](../../models/createobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"name": "Production Langfuse",
"type": "langfuse"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `createObservabilityDestinationRequest` | [models.CreateObservabilityDestinationRequest](../../models/createobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"name": "Production Langfuse",
"type": "langfuse"
} | \ No newline at end of file diff --git a/docs/models/operations/createpresetschatcompletionsglobals.mdx b/docs/models/operations/createpresetschatcompletionsglobals.mdx index 07e252b25..58b66bc3f 100644 --- a/docs/models/operations/createpresetschatcompletionsglobals.mdx +++ b/docs/models/operations/createpresetschatcompletionsglobals.mdx @@ -14,6 +14,6 @@ let value: CreatePresetsChatCompletionsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createpresetschatcompletionsrequest.mdx b/docs/models/operations/createpresetschatcompletionsrequest.mdx index 5e096021f..a0e259ab1 100644 --- a/docs/models/operations/createpresetschatcompletionsrequest.mdx +++ b/docs/models/operations/createpresetschatcompletionsrequest.mdx @@ -28,8 +28,8 @@ let value: CreatePresetsChatCompletionsRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `chatRequest` | [models.ChatRequest](../../models/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *string* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `chatRequest` | [models.ChatRequest](../../models/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/createpresetsmessagesglobals.mdx b/docs/models/operations/createpresetsmessagesglobals.mdx index f871e8c08..bb3498f53 100644 --- a/docs/models/operations/createpresetsmessagesglobals.mdx +++ b/docs/models/operations/createpresetsmessagesglobals.mdx @@ -14,6 +14,6 @@ let value: CreatePresetsMessagesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createpresetsmessagesrequest.mdx b/docs/models/operations/createpresetsmessagesrequest.mdx index 99659fcd2..8aad2f83a 100644 --- a/docs/models/operations/createpresetsmessagesrequest.mdx +++ b/docs/models/operations/createpresetsmessagesrequest.mdx @@ -25,8 +25,8 @@ let value: CreatePresetsMessagesRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messagesRequest` | [models.MessagesRequest](../../models/messagesrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *string* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `messagesRequest` | [models.MessagesRequest](../../models/messagesrequest.mdx) | ✅ | N/A | \{
"max_tokens": 1024,
"messages": [
\{
"content": "Hello, how are you?",
"role": "user"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/createpresetsresponsesglobals.mdx b/docs/models/operations/createpresetsresponsesglobals.mdx index 29ee31820..4c685d171 100644 --- a/docs/models/operations/createpresetsresponsesglobals.mdx +++ b/docs/models/operations/createpresetsresponsesglobals.mdx @@ -14,6 +14,6 @@ let value: CreatePresetsResponsesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createpresetsresponsesrequest.mdx b/docs/models/operations/createpresetsresponsesrequest.mdx index 30f45321b..f960b54ea 100644 --- a/docs/models/operations/createpresetsresponsesrequest.mdx +++ b/docs/models/operations/createpresetsresponsesrequest.mdx @@ -17,8 +17,8 @@ let value: CreatePresetsResponsesRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `responsesRequest` | [models.ResponsesRequest](../../models/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *string* | ✅ | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | +| `responsesRequest` | [models.ResponsesRequest](../../models/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file diff --git a/docs/models/operations/createprivateendpointglobals.mdx b/docs/models/operations/createprivateendpointglobals.mdx index 3a032d87a..c8250647b 100644 --- a/docs/models/operations/createprivateendpointglobals.mdx +++ b/docs/models/operations/createprivateendpointglobals.mdx @@ -14,6 +14,6 @@ let value: CreatePrivateEndpointGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createprivateendpointrequest.mdx b/docs/models/operations/createprivateendpointrequest.mdx index d2e556237..77de028ef 100644 --- a/docs/models/operations/createprivateendpointrequest.mdx +++ b/docs/models/operations/createprivateendpointrequest.mdx @@ -20,8 +20,8 @@ let value: CreatePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `idempotencyKey` | *string* | :heavy_minus_sign: | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | -| `createPrivateEndpointRequest` | [models.CreatePrivateEndpointRequest](../../models/createprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `idempotencyKey` | *string* | ➖ | Retry-safe create: a repeated create with the same key from the same organization returns the endpoint the first request created instead of creating another. The endpoint is returned as it is now. Reusing a key with a different request body (model, provider, base URL, upstream model ID, declared ZDR or region, or pricing) is rejected with 422 `idempotency_key_reused`. `activate` is not compared, and later edits to the endpoint do not affect the comparison. | wayfair-gpt-4o-eastus-2026-09 | +| `createPrivateEndpointRequest` | [models.CreatePrivateEndpointRequest](../../models/createprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/creatererankglobals.mdx b/docs/models/operations/creatererankglobals.mdx index 193bb770a..f7a16172b 100644 --- a/docs/models/operations/creatererankglobals.mdx +++ b/docs/models/operations/creatererankglobals.mdx @@ -14,6 +14,6 @@ let value: CreateRerankGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/creatererankrequest.mdx b/docs/models/operations/creatererankrequest.mdx index 56a83c1ad..bb8ce9423 100644 --- a/docs/models/operations/creatererankrequest.mdx +++ b/docs/models/operations/creatererankrequest.mdx @@ -23,7 +23,7 @@ let value: CreateRerankRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.CreateRerankRequestBody](../../models/operations/creatererankrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"documents": [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
],
"model": "cohere/rerank-v3.5",
"query": "What is the capital of France?",
"top_n": 3
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `requestBody` | [operations.CreateRerankRequestBody](../../models/operations/creatererankrequestbody.mdx) | ✅ | N/A | \{
"documents": [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
],
"model": "cohere/rerank-v3.5",
"query": "What is the capital of France?",
"top_n": 3
} | \ No newline at end of file diff --git a/docs/models/operations/creatererankrequestbody.mdx b/docs/models/operations/creatererankrequestbody.mdx index 454579b95..db5f5cc7e 100644 --- a/docs/models/operations/creatererankrequestbody.mdx +++ b/docs/models/operations/creatererankrequestbody.mdx @@ -23,11 +23,11 @@ let value: CreateRerankRequestBody = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `documents` | *operations.Document*[] | :heavy_check_mark: | The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | -| `model` | *string* | :heavy_check_mark: | The rerank model to use | cohere/rerank-v3.5 | -| `provider` | [models.ProviderPreferences](../../models/providerpreferences.mdx) | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | -| `query` | *string* | :heavy_check_mark: | The search query to rerank documents against | What is the capital of France? | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `topN` | *number* | :heavy_minus_sign: | Number of most relevant documents to return | 3 | -| `trace` | [models.TraceConfig](../../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `user` | *string* | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file +| `documents` | *operations.Document*[] | ✅ | The list of documents to rerank. Documents may be plain strings, or structured objects with `text` and/or `image` for multimodal models. | [
"Paris is the capital of France.",
"Berlin is the capital of Germany."
] | +| `model` | *string* | ✅ | The rerank model to use | cohere/rerank-v3.5 | +| `provider` | [models.ProviderPreferences](../../models/providerpreferences.mdx) | ➖ | N/A | \{
"allow_fallbacks": true
} | +| `query` | *string* | ✅ | The search query to rerank documents against | What is the capital of France? | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `topN` | *number* | ➖ | Number of most relevant documents to return | 3 | +| `trace` | [models.TraceConfig](../../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `user` | *string* | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file diff --git a/docs/models/operations/creatererankresponsebody.mdx b/docs/models/operations/creatererankresponsebody.mdx index c5cf33dc5..ac7d0263b 100644 --- a/docs/models/operations/creatererankresponsebody.mdx +++ b/docs/models/operations/creatererankresponsebody.mdx @@ -25,8 +25,8 @@ let value: CreateRerankResponseBody = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | -| `model` | *string* | :heavy_check_mark: | The model used for reranking | cohere/rerank-v3.5 | -| `provider` | *string* | :heavy_minus_sign: | The provider that served the rerank request | Cohere | -| `results` | [operations.Result](../../models/operations/result.mdx)[] | :heavy_check_mark: | List of rerank results sorted by relevance | [
\{
"document": \{
"text": "Paris is the capital of France."
},
"index": 0,
"relevance_score": 0.98
}
] | -| `usage` | [operations.CreateRerankUsage](../../models/operations/creatererankusage.mdx) | :heavy_minus_sign: | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file +| `id` | *string* | ➖ | Unique identifier for the rerank response (ORID format) | gen-rerank-1234567890-abc | +| `model` | *string* | ✅ | The model used for reranking | cohere/rerank-v3.5 | +| `provider` | *string* | ➖ | The provider that served the rerank request | Cohere | +| `results` | [operations.Result](../../models/operations/result.mdx)[] | ✅ | List of rerank results sorted by relevance | [
\{
"document": \{
"text": "Paris is the capital of France."
},
"index": 0,
"relevance_score": 0.98
}
] | +| `usage` | [operations.CreateRerankUsage](../../models/operations/creatererankusage.mdx) | ➖ | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file diff --git a/docs/models/operations/creatererankusage.mdx b/docs/models/operations/creatererankusage.mdx index fa6429b8b..f650e3f76 100644 --- a/docs/models/operations/creatererankusage.mdx +++ b/docs/models/operations/creatererankusage.mdx @@ -16,6 +16,6 @@ let value: CreateRerankUsage = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `cost` | *number* | :heavy_minus_sign: | Cost of the request in credits | 0.001 | -| `searchUnits` | *number* | :heavy_minus_sign: | Number of search units consumed (Cohere billing) | 1 | -| `totalTokens` | *number* | :heavy_minus_sign: | Total number of tokens used | 150 | \ No newline at end of file +| `cost` | *number* | ➖ | Cost of the request in credits | 0.001 | +| `searchUnits` | *number* | ➖ | Number of search units consumed (Cohere billing) | 1 | +| `totalTokens` | *number* | ➖ | Total number of tokens used | 150 | \ No newline at end of file diff --git a/docs/models/operations/createresponsesglobals.mdx b/docs/models/operations/createresponsesglobals.mdx index 34e6f21bf..6bfe74e7b 100644 --- a/docs/models/operations/createresponsesglobals.mdx +++ b/docs/models/operations/createresponsesglobals.mdx @@ -14,6 +14,6 @@ let value: CreateResponsesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createresponsesrequest.mdx b/docs/models/operations/createresponsesrequest.mdx index 2f957e8df..256494792 100644 --- a/docs/models/operations/createresponsesrequest.mdx +++ b/docs/models/operations/createresponsesrequest.mdx @@ -16,8 +16,8 @@ let value: CreateResponsesRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `xOpenRouterMetadata` | [models.MetadataLevel](../../models/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `responsesRequest` | [models.ResponsesRequest](../../models/responsesrequest.mdx) | :heavy_check_mark: | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `xOpenRouterMetadata` | [models.MetadataLevel](../../models/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `responsesRequest` | [models.ResponsesRequest](../../models/responsesrequest.mdx) | ✅ | N/A | \{
"input": [
\{
"content": "Hello, how are you?",
"role": "user",
"type": "message"
}
],
"model": "anthropic/claude-4.5-sonnet-20250929",
"temperature": 0.7,
"tools": [
\{
"description": "Get the current weather in a given location",
"name": "get_current_weather",
"parameters": \{
"properties": \{
"location": \{
"type": "string"
}
},
"type": "object"
},
"type": "function"
}
],
"top_p": 0.9
} | \ No newline at end of file diff --git a/docs/models/operations/createscimgroupmappingglobals.mdx b/docs/models/operations/createscimgroupmappingglobals.mdx index 8e4f19d43..c2987f84f 100644 --- a/docs/models/operations/createscimgroupmappingglobals.mdx +++ b/docs/models/operations/createscimgroupmappingglobals.mdx @@ -14,6 +14,6 @@ let value: CreateScimGroupMappingGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createscimgroupmappingrequest.mdx b/docs/models/operations/createscimgroupmappingrequest.mdx index 6796ca9b7..e0f04bb76 100644 --- a/docs/models/operations/createscimgroupmappingrequest.mdx +++ b/docs/models/operations/createscimgroupmappingrequest.mdx @@ -20,7 +20,7 @@ let value: CreateScimGroupMappingRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `createScimGroupMappingRequest` | [models.CreateScimGroupMappingRequest](../../models/createscimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `createScimGroupMappingRequest` | [models.CreateScimGroupMappingRequest](../../models/createscimgroupmappingrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/createscimsyncjobglobals.mdx b/docs/models/operations/createscimsyncjobglobals.mdx index 7813b03dc..48a37bcd0 100644 --- a/docs/models/operations/createscimsyncjobglobals.mdx +++ b/docs/models/operations/createscimsyncjobglobals.mdx @@ -14,6 +14,6 @@ let value: CreateScimSyncJobGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createscimsyncjobrequest.mdx b/docs/models/operations/createscimsyncjobrequest.mdx index fc8b68741..dd3f4fa3c 100644 --- a/docs/models/operations/createscimsyncjobrequest.mdx +++ b/docs/models/operations/createscimsyncjobrequest.mdx @@ -14,6 +14,6 @@ let value: CreateScimSyncJobRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createscimsyncjobresponse.mdx b/docs/models/operations/createscimsyncjobresponse.mdx index 2199321b3..959dc6d7e 100644 --- a/docs/models/operations/createscimsyncjobresponse.mdx +++ b/docs/models/operations/createscimsyncjobresponse.mdx @@ -28,5 +28,5 @@ let value: CreateScimSyncJobResponse = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `headers` | Record\ | :heavy_check_mark: | N/A | -| `result` | [models.CreateScimSyncJobResponse](../../models/createscimsyncjobresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `headers` | Record\ | ✅ | N/A | +| `result` | [models.CreateScimSyncJobResponse](../../models/createscimsyncjobresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/createsystemoneglobals.mdx b/docs/models/operations/createsystemoneglobals.mdx index 50ad8be8e..c03945778 100644 --- a/docs/models/operations/createsystemoneglobals.mdx +++ b/docs/models/operations/createsystemoneglobals.mdx @@ -14,6 +14,6 @@ let value: CreateSystemoneGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createsystemonerequest.mdx b/docs/models/operations/createsystemonerequest.mdx index d5b6c52bc..4a0aed1ba 100644 --- a/docs/models/operations/createsystemonerequest.mdx +++ b/docs/models/operations/createsystemonerequest.mdx @@ -20,7 +20,7 @@ let value: CreateSystemoneRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `decisionsRequest` | [models.DecisionsRequest](../../models/decisionsrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `decisionsRequest` | [models.DecisionsRequest](../../models/decisionsrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/createvideosglobals.mdx b/docs/models/operations/createvideosglobals.mdx index f0269584f..af705109b 100644 --- a/docs/models/operations/createvideosglobals.mdx +++ b/docs/models/operations/createvideosglobals.mdx @@ -14,6 +14,6 @@ let value: CreateVideosGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createvideosrequest.mdx b/docs/models/operations/createvideosrequest.mdx index 46f719cf0..f9e14c241 100644 --- a/docs/models/operations/createvideosrequest.mdx +++ b/docs/models/operations/createvideosrequest.mdx @@ -18,7 +18,7 @@ let value: CreateVideosRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `videoGenerationRequest` | [models.VideoGenerationRequest](../../models/videogenerationrequest.mdx) | :heavy_check_mark: | N/A | \{
"aspect_ratio": "16:9",
"duration": 8,
"model": "google/veo-3.1",
"prompt": "A serene mountain landscape at sunset",
"resolution": "720p"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `videoGenerationRequest` | [models.VideoGenerationRequest](../../models/videogenerationrequest.mdx) | ✅ | N/A | \{
"aspect_ratio": "16:9",
"duration": 8,
"model": "google/veo-3.1",
"prompt": "A serene mountain landscape at sunset",
"resolution": "720p"
} | \ No newline at end of file diff --git a/docs/models/operations/createworkspaceglobals.mdx b/docs/models/operations/createworkspaceglobals.mdx index 30d87788c..b706be383 100644 --- a/docs/models/operations/createworkspaceglobals.mdx +++ b/docs/models/operations/createworkspaceglobals.mdx @@ -14,6 +14,6 @@ let value: CreateWorkspaceGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/createworkspacerequest.mdx b/docs/models/operations/createworkspacerequest.mdx index 05a8ce2d9..20bdf5ba2 100644 --- a/docs/models/operations/createworkspacerequest.mdx +++ b/docs/models/operations/createworkspacerequest.mdx @@ -19,7 +19,7 @@ let value: CreateWorkspaceRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `createWorkspaceRequest` | [models.CreateWorkspaceRequest](../../models/createworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"name": "Production",
"slug": "production"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `createWorkspaceRequest` | [models.CreateWorkspaceRequest](../../models/createworkspacerequest.mdx) | ✅ | N/A | \{
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"name": "Production",
"slug": "production"
} | \ No newline at end of file diff --git a/docs/models/operations/deletebatchglobals.mdx b/docs/models/operations/deletebatchglobals.mdx index 5365459af..80de8b4d5 100644 --- a/docs/models/operations/deletebatchglobals.mdx +++ b/docs/models/operations/deletebatchglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteBatchGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deletebatchrequest.mdx b/docs/models/operations/deletebatchrequest.mdx index 18928c99e..7ca240919 100644 --- a/docs/models/operations/deletebatchrequest.mdx +++ b/docs/models/operations/deletebatchrequest.mdx @@ -16,7 +16,7 @@ let value: DeleteBatchRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/models/operations/deletebyokkeyglobals.mdx b/docs/models/operations/deletebyokkeyglobals.mdx index 25e588380..5a8bfc47f 100644 --- a/docs/models/operations/deletebyokkeyglobals.mdx +++ b/docs/models/operations/deletebyokkeyglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteBYOKKeyGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deletebyokkeyrequest.mdx b/docs/models/operations/deletebyokkeyrequest.mdx index d01f99bc7..553beb50b 100644 --- a/docs/models/operations/deletebyokkeyrequest.mdx +++ b/docs/models/operations/deletebyokkeyrequest.mdx @@ -16,7 +16,7 @@ let value: DeleteBYOKKeyRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/models/operations/deleteenduserglobals.mdx b/docs/models/operations/deleteenduserglobals.mdx index e06315db5..83b02ef5a 100644 --- a/docs/models/operations/deleteenduserglobals.mdx +++ b/docs/models/operations/deleteenduserglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteEndUserGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deleteenduserrequest.mdx b/docs/models/operations/deleteenduserrequest.mdx index 6626390b1..e00dbf6a8 100644 --- a/docs/models/operations/deleteenduserrequest.mdx +++ b/docs/models/operations/deleteenduserrequest.mdx @@ -16,7 +16,7 @@ let value: DeleteEndUserRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `user` | *string* | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `user` | *string* | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file diff --git a/docs/models/operations/deletefileglobals.mdx b/docs/models/operations/deletefileglobals.mdx index 6f33ed8a4..a6b3b0169 100644 --- a/docs/models/operations/deletefileglobals.mdx +++ b/docs/models/operations/deletefileglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteFileGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deletefilerequest.mdx b/docs/models/operations/deletefilerequest.mdx index f84c73e33..ec0ffd77b 100644 --- a/docs/models/operations/deletefilerequest.mdx +++ b/docs/models/operations/deletefilerequest.mdx @@ -16,9 +16,9 @@ let value: DeleteFileRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `fileId` | *string* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `fileId` | *string* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspaceId` | *string* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/deleteguardrailglobals.mdx b/docs/models/operations/deleteguardrailglobals.mdx index be4c0daf2..143cb39ad 100644 --- a/docs/models/operations/deleteguardrailglobals.mdx +++ b/docs/models/operations/deleteguardrailglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteGuardrailGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deleteguardrailrequest.mdx b/docs/models/operations/deleteguardrailrequest.mdx index fb500f630..8ee961613 100644 --- a/docs/models/operations/deleteguardrailrequest.mdx +++ b/docs/models/operations/deleteguardrailrequest.mdx @@ -16,7 +16,7 @@ let value: DeleteGuardrailRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/deleteinternglobals.mdx b/docs/models/operations/deleteinternglobals.mdx index 33484c212..c6149f90a 100644 --- a/docs/models/operations/deleteinternglobals.mdx +++ b/docs/models/operations/deleteinternglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteInternGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deleteinternrequest.mdx b/docs/models/operations/deleteinternrequest.mdx index 5d82e365c..ac0f6fe9c 100644 --- a/docs/models/operations/deleteinternrequest.mdx +++ b/docs/models/operations/deleteinternrequest.mdx @@ -19,8 +19,8 @@ let value: DeleteInternRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `deleteInternRequest` | [models.DeleteInternRequest](../../models/deleteinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `deleteInternRequest` | [models.DeleteInternRequest](../../models/deleteinternrequest.mdx) | ✅ | N/A | \{
"acknowledge_workspace_loss": true
} | \ No newline at end of file diff --git a/docs/models/operations/deleteinternvaultsecretglobals.mdx b/docs/models/operations/deleteinternvaultsecretglobals.mdx index d3ca6ff68..b2b82e069 100644 --- a/docs/models/operations/deleteinternvaultsecretglobals.mdx +++ b/docs/models/operations/deleteinternvaultsecretglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteInternVaultSecretGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deleteinternvaultsecretrequest.mdx b/docs/models/operations/deleteinternvaultsecretrequest.mdx index eeb49ea1b..d245d4735 100644 --- a/docs/models/operations/deleteinternvaultsecretrequest.mdx +++ b/docs/models/operations/deleteinternvaultsecretrequest.mdx @@ -17,8 +17,8 @@ let value: DeleteInternVaultSecretRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *string* | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *string* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file diff --git a/docs/models/operations/deletekeysglobals.mdx b/docs/models/operations/deletekeysglobals.mdx index e343a70e5..e749e5798 100644 --- a/docs/models/operations/deletekeysglobals.mdx +++ b/docs/models/operations/deletekeysglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteKeysGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deletekeysrequest.mdx b/docs/models/operations/deletekeysrequest.mdx index 8e5a74bc5..367a67f6e 100644 --- a/docs/models/operations/deletekeysrequest.mdx +++ b/docs/models/operations/deletekeysrequest.mdx @@ -16,7 +16,7 @@ let value: DeleteKeysRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `hash` | *string* | ✅ | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/models/operations/deletekeysresponse.mdx b/docs/models/operations/deletekeysresponse.mdx index 41a8cf5bb..e099c48a6 100644 --- a/docs/models/operations/deletekeysresponse.mdx +++ b/docs/models/operations/deletekeysresponse.mdx @@ -18,4 +18,4 @@ let value: DeleteKeysResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `deleted` | *true* | :heavy_check_mark: | Confirmation that the API key was deleted | true | \ No newline at end of file +| `deleted` | *true* | ✅ | Confirmation that the API key was deleted | true | \ No newline at end of file diff --git a/docs/models/operations/deleteobservabilitydestinationglobals.mdx b/docs/models/operations/deleteobservabilitydestinationglobals.mdx index f9f0e032f..6e904860a 100644 --- a/docs/models/operations/deleteobservabilitydestinationglobals.mdx +++ b/docs/models/operations/deleteobservabilitydestinationglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteObservabilityDestinationGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deleteobservabilitydestinationrequest.mdx b/docs/models/operations/deleteobservabilitydestinationrequest.mdx index 9dc867043..5af292350 100644 --- a/docs/models/operations/deleteobservabilitydestinationrequest.mdx +++ b/docs/models/operations/deleteobservabilitydestinationrequest.mdx @@ -16,7 +16,7 @@ let value: DeleteObservabilityDestinationRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/models/operations/deleteprivateendpointglobals.mdx b/docs/models/operations/deleteprivateendpointglobals.mdx index d098bee93..628c22c55 100644 --- a/docs/models/operations/deleteprivateendpointglobals.mdx +++ b/docs/models/operations/deleteprivateendpointglobals.mdx @@ -14,6 +14,6 @@ let value: DeletePrivateEndpointGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deleteprivateendpointrequest.mdx b/docs/models/operations/deleteprivateendpointrequest.mdx index 984b8f16e..de57e3fb7 100644 --- a/docs/models/operations/deleteprivateendpointrequest.mdx +++ b/docs/models/operations/deleteprivateendpointrequest.mdx @@ -16,8 +16,8 @@ let value: DeletePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `draftOnly` | [operations.DraftOnly](../../models/operations/draftonly.mdx) | :heavy_minus_sign: | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `draftOnly` | [operations.DraftOnly](../../models/operations/draftonly.mdx) | ➖ | When `true`, only delete the endpoint if it is still a draft (409 otherwise). | | \ No newline at end of file diff --git a/docs/models/operations/deletescimgroupmappingglobals.mdx b/docs/models/operations/deletescimgroupmappingglobals.mdx index 4eeafa3e5..9eb08917a 100644 --- a/docs/models/operations/deletescimgroupmappingglobals.mdx +++ b/docs/models/operations/deletescimgroupmappingglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteScimGroupMappingGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deletescimgroupmappingrequest.mdx b/docs/models/operations/deletescimgroupmappingrequest.mdx index cf6f3f55f..58db999f9 100644 --- a/docs/models/operations/deletescimgroupmappingrequest.mdx +++ b/docs/models/operations/deletescimgroupmappingrequest.mdx @@ -17,8 +17,8 @@ let value: DeleteScimGroupMappingRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `keepMembers` | *operations.KeepMembers* | :heavy_check_mark: | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | N/A | | +| `keepMembers` | *operations.KeepMembers* | ✅ | Required. Whether to keep workspace members after deleting the mapping. `false` **removes** the members this mapping granted access to; `true` deletes the mapping while leaving membership intact as manually-managed. There is deliberately no default — omitting it returns `400` so the destructive path cannot be reached by accident. Mirrors the dashboard, whose `DeleteMappingSchema.keepMembers` is likewise required. | false | \ No newline at end of file diff --git a/docs/models/operations/deletevaultsecretglobals.mdx b/docs/models/operations/deletevaultsecretglobals.mdx index dc757c691..cfab57a4a 100644 --- a/docs/models/operations/deletevaultsecretglobals.mdx +++ b/docs/models/operations/deletevaultsecretglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteVaultSecretGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deletevaultsecretrequest.mdx b/docs/models/operations/deletevaultsecretrequest.mdx index ba6b5d302..4de45c409 100644 --- a/docs/models/operations/deletevaultsecretrequest.mdx +++ b/docs/models/operations/deletevaultsecretrequest.mdx @@ -16,7 +16,7 @@ let value: DeleteVaultSecretRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `name` | *string* | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `name` | *string* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | \ No newline at end of file diff --git a/docs/models/operations/deleteworkspacebudgetglobals.mdx b/docs/models/operations/deleteworkspacebudgetglobals.mdx index dbd99fbf2..20f35b0de 100644 --- a/docs/models/operations/deleteworkspacebudgetglobals.mdx +++ b/docs/models/operations/deleteworkspacebudgetglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteWorkspaceBudgetGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deleteworkspacebudgetrequest.mdx b/docs/models/operations/deleteworkspacebudgetrequest.mdx index 4e497b43a..84e9af581 100644 --- a/docs/models/operations/deleteworkspacebudgetrequest.mdx +++ b/docs/models/operations/deleteworkspacebudgetrequest.mdx @@ -17,8 +17,8 @@ let value: DeleteWorkspaceBudgetRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspaceRef` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [models.WorkspaceBudgetInterval](../../models/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspaceRef` | *string* | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [models.WorkspaceBudgetInterval](../../models/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file diff --git a/docs/models/operations/deleteworkspaceglobals.mdx b/docs/models/operations/deleteworkspaceglobals.mdx index a19eb4e38..03de99426 100644 --- a/docs/models/operations/deleteworkspaceglobals.mdx +++ b/docs/models/operations/deleteworkspaceglobals.mdx @@ -14,6 +14,6 @@ let value: DeleteWorkspaceGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/deleteworkspacerequest.mdx b/docs/models/operations/deleteworkspacerequest.mdx index 450872c08..aea0b597a 100644 --- a/docs/models/operations/deleteworkspacerequest.mdx +++ b/docs/models/operations/deleteworkspacerequest.mdx @@ -16,8 +16,8 @@ let value: DeleteWorkspaceRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `confirmDefaultWorkspaceDeletion` | *boolean* | :heavy_minus_sign: | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The workspace ID (UUID) or slug | production | +| `confirmDefaultWorkspaceDeletion` | *boolean* | ➖ | Required to delete the default workspace. Deleting it permanently disables the account’s unscoped inference API keys (management/provisioning keys are retained) and its budgets, guardrails, classifiers, and broadcast destinations. Ignored for non-default workspaces. | false | \ No newline at end of file diff --git a/docs/models/operations/dimension.mdx b/docs/models/operations/dimension.mdx index b1b8078fe..fd30e4070 100644 --- a/docs/models/operations/dimension.mdx +++ b/docs/models/operations/dimension.mdx @@ -17,5 +17,5 @@ let value: Dimension = { | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `displayLabel` | *string* | :heavy_check_mark: | Human-readable label | Model | -| `name` | *string* | :heavy_check_mark: | Dimension identifier used in query requests | model | \ No newline at end of file +| `displayLabel` | *string* | ✅ | Human-readable label | Model | +| `name` | *string* | ✅ | Dimension identifier used in query requests | model | \ No newline at end of file diff --git a/docs/models/operations/disableprivateendpointglobals.mdx b/docs/models/operations/disableprivateendpointglobals.mdx index bf2a851a0..3c3adcdc4 100644 --- a/docs/models/operations/disableprivateendpointglobals.mdx +++ b/docs/models/operations/disableprivateendpointglobals.mdx @@ -14,6 +14,6 @@ let value: DisablePrivateEndpointGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/disableprivateendpointrequest.mdx b/docs/models/operations/disableprivateendpointrequest.mdx index 5dedf94b4..938332b63 100644 --- a/docs/models/operations/disableprivateendpointrequest.mdx +++ b/docs/models/operations/disableprivateendpointrequest.mdx @@ -16,7 +16,7 @@ let value: DisablePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/documentrequest.mdx b/docs/models/operations/documentrequest.mdx index 2327d7975..396ba082e 100644 --- a/docs/models/operations/documentrequest.mdx +++ b/docs/models/operations/documentrequest.mdx @@ -16,5 +16,5 @@ let value: DocumentRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `image` | *string* | :heavy_minus_sign: | An image associated with the document, as a remote URL (http/https) or a base64-encoded data URI (data:image/...). | https://upload.wikimedia.org/wikipedia/commons/thumb/8/8b/Phytogenic.png | -| `text` | *string* | :heavy_minus_sign: | The document text | AI enables robots to perceive, plan, and act autonomously. | \ No newline at end of file +| `image` | *string* | ➖ | An image associated with the document, as a remote URL (http/https) or a base64-encoded data URI (data:image/...). | https://upload.wikimedia.org/wikipedia/commons/thumb/8/8b/Phytogenic.png | +| `text` | *string* | ➖ | The document text | AI enables robots to perceive, plan, and act autonomously. | \ No newline at end of file diff --git a/docs/models/operations/documentresponse.mdx b/docs/models/operations/documentresponse.mdx index fa99fab64..61891b1f1 100644 --- a/docs/models/operations/documentresponse.mdx +++ b/docs/models/operations/documentresponse.mdx @@ -16,5 +16,5 @@ let value: DocumentResponse = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `image` | *string* | :heavy_minus_sign: | The image (URL or data URI) from the original document | https://example.com/image.png | -| `text` | *string* | :heavy_minus_sign: | The document text | Paris is the capital of France. | \ No newline at end of file +| `image` | *string* | ➖ | The image (URL or data URI) from the original document | https://example.com/image.png | +| `text` | *string* | ➖ | The document text | Paris is the capital of France. | \ No newline at end of file diff --git a/docs/models/operations/downloadcontainerfilecontentglobals.mdx b/docs/models/operations/downloadcontainerfilecontentglobals.mdx index 0b90009e3..0ff5609d0 100644 --- a/docs/models/operations/downloadcontainerfilecontentglobals.mdx +++ b/docs/models/operations/downloadcontainerfilecontentglobals.mdx @@ -14,6 +14,6 @@ let value: DownloadContainerFileContentGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/downloadcontainerfilecontentrequest.mdx b/docs/models/operations/downloadcontainerfilecontentrequest.mdx index a3c379e35..34bfc3e01 100644 --- a/docs/models/operations/downloadcontainerfilecontentrequest.mdx +++ b/docs/models/operations/downloadcontainerfilecontentrequest.mdx @@ -17,8 +17,8 @@ let value: DownloadContainerFileContentRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `containerId` | *string* | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `fileId` | *string* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `containerId` | *string* | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `fileId` | *string* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/downloadfilecontentglobals.mdx b/docs/models/operations/downloadfilecontentglobals.mdx index c00350bc3..186c6c256 100644 --- a/docs/models/operations/downloadfilecontentglobals.mdx +++ b/docs/models/operations/downloadfilecontentglobals.mdx @@ -14,6 +14,6 @@ let value: DownloadFileContentGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/downloadfilecontentrequest.mdx b/docs/models/operations/downloadfilecontentrequest.mdx index 2d1ff0a87..560599c45 100644 --- a/docs/models/operations/downloadfilecontentrequest.mdx +++ b/docs/models/operations/downloadfilecontentrequest.mdx @@ -16,9 +16,9 @@ let value: DownloadFileContentRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `fileId` | *string* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `fileId` | *string* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspaceId` | *string* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/enableprivateendpointglobals.mdx b/docs/models/operations/enableprivateendpointglobals.mdx index 5109c77b0..8cfcd4e81 100644 --- a/docs/models/operations/enableprivateendpointglobals.mdx +++ b/docs/models/operations/enableprivateendpointglobals.mdx @@ -14,6 +14,6 @@ let value: EnablePrivateEndpointGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/enableprivateendpointrequest.mdx b/docs/models/operations/enableprivateendpointrequest.mdx index 18e867840..a10ceb73c 100644 --- a/docs/models/operations/enableprivateendpointrequest.mdx +++ b/docs/models/operations/enableprivateendpointrequest.mdx @@ -16,7 +16,7 @@ let value: EnablePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/exchangeauthcodeforapikeyglobals.mdx b/docs/models/operations/exchangeauthcodeforapikeyglobals.mdx index 17402646d..3fa8de1fc 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyglobals.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyglobals.mdx @@ -14,6 +14,6 @@ let value: ExchangeAuthCodeForAPIKeyGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx index 773deda36..2b7d595e5 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx @@ -18,7 +18,7 @@ let value: ExchangeAuthCodeForAPIKeyRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `requestBody` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](../../models/operations/exchangeauthcodeforapikeyrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"code": "auth_code_abc123def456",
"code_challenge_method": "S256",
"code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `requestBody` | [operations.ExchangeAuthCodeForAPIKeyRequestBody](../../models/operations/exchangeauthcodeforapikeyrequestbody.mdx) | ✅ | N/A | \{
"code": "auth_code_abc123def456",
"code_challenge_method": "S256",
"code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"
} | \ No newline at end of file diff --git a/docs/models/operations/exchangeauthcodeforapikeyrequestbody.mdx b/docs/models/operations/exchangeauthcodeforapikeyrequestbody.mdx index 761049a02..778c9e478 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyrequestbody.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyrequestbody.mdx @@ -16,6 +16,6 @@ let value: ExchangeAuthCodeForAPIKeyRequestBody = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *string* | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `codeChallengeMethod` | [operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | -| `codeVerifier` | *string* | :heavy_minus_sign: | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | \ No newline at end of file +| `code` | *string* | ✅ | The authorization code received from the OAuth redirect | auth_code_abc123def456 | +| `codeChallengeMethod` | [operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod.mdx) | ➖ | The method used to generate the code challenge | S256 | +| `codeVerifier` | *string* | ➖ | The code verifier if code_challenge was used in the authorization request | dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk | \ No newline at end of file diff --git a/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx b/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx index 52a4a8f2c..30aa6a02b 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyresponse.mdx @@ -20,5 +20,5 @@ let value: ExchangeAuthCodeForAPIKeyResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *string* | :heavy_check_mark: | The API key to use for OpenRouter requests | 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 | -| `userId` | *string* | :heavy_check_mark: | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file +| `key` | *string* | ✅ | The API key to use for OpenRouter requests | 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 | +| `userId` | *string* | ✅ | User ID associated with the API key | user_2yOPcMpKoQhcd4bVgSMlELRaIah | \ No newline at end of file diff --git a/docs/models/operations/external.mdx b/docs/models/operations/external.mdx index 960c13e9e..d03204c4b 100644 --- a/docs/models/operations/external.mdx +++ b/docs/models/operations/external.mdx @@ -18,5 +18,5 @@ let value: External = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKey` | *string* | :heavy_minus_sign: | Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned. | | -| `user` | *string* | :heavy_check_mark: | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file +| `apiKey` | *string* | ➖ | Optional partner-supplied API key with a minimum length of 32 characters and sufficient entropy. Stored as a SHA-256 hash and never returned. | | +| `user` | *string* | ✅ | Partner's end-user identifier for attribution. | partner-user-123 | \ No newline at end of file diff --git a/docs/models/operations/filter.mdx b/docs/models/operations/filter.mdx index 01007012e..400ff510e 100644 --- a/docs/models/operations/filter.mdx +++ b/docs/models/operations/filter.mdx @@ -18,7 +18,7 @@ let value: Filter = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `field` | *string* | :heavy_check_mark: | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | -| `includeUnset` | *boolean* | :heavy_minus_sign: | Include rows where the dimension has no value. Applies only to the `in` and `not_in` operators and dimensions that have an unset bucket. | | -| `operator` | *string* | :heavy_check_mark: | Filter operator | eq | -| `value` | *operations.Value1* | :heavy_check_mark: | Filter value (scalar or array depending on operator). Several dimensions are enriched in responses (returned as human-readable labels), but filters must use the underlying ID: `api_key_id` — numeric ID (from generation metadata) or key hash (64-char hex from GET /api/v1/keys, resolved server-side); `user` — Clerk user ID (e.g. "user_abc123"), not the display name; `workspace` — workspace UUID, not the workspace name (filtering or grouping by the account default workspace also covers activity recorded before workspace resolution existed, which is attributed to that default workspace); `app` — numeric app ID, not the app title; `model` — permaslug (e.g. "openai/gpt-4o"), not the display name. Other dimensions (provider, origin, country, etc.) are not enriched and accept the value as returned. | | \ No newline at end of file +| `field` | *string* | ✅ | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | +| `includeUnset` | *boolean* | ➖ | Include rows where the dimension has no value. Applies only to the `in` and `not_in` operators and dimensions that have an unset bucket. | | +| `operator` | *string* | ✅ | Filter operator | eq | +| `value` | *operations.Value1* | ✅ | Filter value (scalar or array depending on operator). Several dimensions are enriched in responses (returned as human-readable labels), but filters must use the underlying ID: `api_key_id` — numeric ID (from generation metadata) or key hash (64-char hex from GET /api/v1/keys, resolved server-side); `user` — Clerk user ID (e.g. "user_abc123"), not the display name; `workspace` — workspace UUID, not the workspace name (filtering or grouping by the account default workspace also covers activity recorded before workspace resolution existed, which is attributed to that default workspace); `app` — numeric app ID, not the app title; `model` — permaslug (e.g. "openai/gpt-4o"), not the display name. Other dimensions (provider, origin, country, etc.) are not enriched and accept the value as returned. | | \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetadata.mdx b/docs/models/operations/getanalyticsmetadata.mdx index f3e248455..05c907170 100644 --- a/docs/models/operations/getanalyticsmetadata.mdx +++ b/docs/models/operations/getanalyticsmetadata.mdx @@ -31,7 +31,7 @@ let value: GetAnalyticsMetaData = { | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `dimensions` | [operations.Dimension](../../models/operations/dimension.mdx)[] | :heavy_check_mark: | N/A | -| `granularities` | [operations.Granularity](../../models/operations/granularity.mdx)[] | :heavy_check_mark: | N/A | -| `metrics` | [operations.Metric](../../models/operations/metric.mdx)[] | :heavy_check_mark: | N/A | -| `operators` | [operations.Operator](../../models/operations/operator.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `dimensions` | [operations.Dimension](../../models/operations/dimension.mdx)[] | ✅ | N/A | +| `granularities` | [operations.Granularity](../../models/operations/granularity.mdx)[] | ✅ | N/A | +| `metrics` | [operations.Metric](../../models/operations/metric.mdx)[] | ✅ | N/A | +| `operators` | [operations.Operator](../../models/operations/operator.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetaglobals.mdx b/docs/models/operations/getanalyticsmetaglobals.mdx index d94adf232..424c02c97 100644 --- a/docs/models/operations/getanalyticsmetaglobals.mdx +++ b/docs/models/operations/getanalyticsmetaglobals.mdx @@ -14,6 +14,6 @@ let value: GetAnalyticsMetaGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetarequest.mdx b/docs/models/operations/getanalyticsmetarequest.mdx index 7679a4b12..13a12056f 100644 --- a/docs/models/operations/getanalyticsmetarequest.mdx +++ b/docs/models/operations/getanalyticsmetarequest.mdx @@ -14,6 +14,6 @@ let value: GetAnalyticsMetaRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetaresponse.mdx b/docs/models/operations/getanalyticsmetaresponse.mdx index 300a5308e..e6ce55f76 100644 --- a/docs/models/operations/getanalyticsmetaresponse.mdx +++ b/docs/models/operations/getanalyticsmetaresponse.mdx @@ -40,4 +40,4 @@ let value: GetAnalyticsMetaResponse = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `data` | [operations.GetAnalyticsMetaData](../../models/operations/getanalyticsmetadata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [operations.GetAnalyticsMetaData](../../models/operations/getanalyticsmetadata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getapprankingsglobals.mdx b/docs/models/operations/getapprankingsglobals.mdx index d9542de67..8b72f476d 100644 --- a/docs/models/operations/getapprankingsglobals.mdx +++ b/docs/models/operations/getapprankingsglobals.mdx @@ -14,6 +14,6 @@ let value: GetAppRankingsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getapprankingsrequest.mdx b/docs/models/operations/getapprankingsrequest.mdx index d17fc2d87..69f321edf 100644 --- a/docs/models/operations/getapprankingsrequest.mdx +++ b/docs/models/operations/getapprankingsrequest.mdx @@ -14,13 +14,13 @@ let value: GetAppRankingsRequest = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `category` | [operations.GetAppRankingsCategory](../../models/operations/getapprankingscategory.mdx) | :heavy_minus_sign: | Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group. | coding | -| `subcategory` | [operations.Subcategory](../../models/operations/subcategory.mdx) | :heavy_minus_sign: | Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent. | cli-agent | -| `sort` | [operations.GetAppRankingsSort](../../models/operations/getapprankingssort.mdx) | :heavy_minus_sign: | `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results. | popular | -| `startDate` | *string* | :heavy_minus_sign: | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | -| `endDate` | *string* | :heavy_minus_sign: | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of apps to return (1-100). Defaults to 50. | 50 | -| `offset` | *number* | :heavy_minus_sign: | Number of ranked apps to skip before the first returned row (0-100). Defaults to 0. `rank` stays absolute, so the first row of `offset=50` is `rank: 51`. | 0 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `category` | [operations.GetAppRankingsCategory](../../models/operations/getapprankingscategory.mdx) | ➖ | Marketplace category group to filter by (e.g. `coding`). Only apps tagged with a subcategory inside this group are returned. Mutually combinable with `subcategory` — when both are supplied the `subcategory` must belong to the `category` group. | coding | +| `subcategory` | [operations.Subcategory](../../models/operations/subcategory.mdx) | ➖ | Marketplace subcategory to filter by (e.g. `cli-agent`). Takes precedence over `category` for the actual filter; when `category` is also supplied the pair must be consistent. | cli-agent | +| `sort` | [operations.GetAppRankingsSort](../../models/operations/getapprankingssort.mdx) | ➖ | `popular` ranks apps by total token volume inside the date window. `trending` ranks apps by absolute excess token growth: window volume minus the average volume of the three equal-length periods immediately preceding the window. Apps with no excess growth are omitted from `trending` results. | popular | +| `startDate` | *string* | ➖ | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | +| `endDate` | *string* | ➖ | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | +| `limit` | *number* | ➖ | Maximum number of apps to return (1-100). Defaults to 50. | 50 | +| `offset` | *number* | ➖ | Number of ranked apps to skip before the first returned row (0-100). Defaults to 0. `rank` stays absolute, so the first row of `offset=50` is `rank: 51`. | 0 | \ No newline at end of file diff --git a/docs/models/operations/getapprankingsresponse.mdx b/docs/models/operations/getapprankingsresponse.mdx index c498df47f..b3679247c 100644 --- a/docs/models/operations/getapprankingsresponse.mdx +++ b/docs/models/operations/getapprankingsresponse.mdx @@ -39,4 +39,4 @@ let value: GetAppRankingsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.AppRankingsResponse](../../models/apprankingsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"app_id": 12345,
"app_name": "Cline",
"rank": 1,
"total_requests": 4321,
"total_tokens": "12345678"
},
\{
"app_id": 67890,
"app_name": "Roo Code",
"rank": 2,
"total_requests": 2109,
"total_tokens": "9876543"
}
],
"meta": \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file +| `result` | [models.AppRankingsResponse](../../models/apprankingsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"app_id": 12345,
"app_name": "Cline",
"rank": 1,
"total_requests": 4321,
"total_tokens": "12345678"
},
\{
"app_id": 67890,
"app_name": "Roo Code",
"rank": 2,
"total_requests": 2109,
"total_tokens": "9876543"
}
],
"meta": \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file diff --git a/docs/models/operations/getbatchesglobals.mdx b/docs/models/operations/getbatchesglobals.mdx index 6d432a7c4..b3193495e 100644 --- a/docs/models/operations/getbatchesglobals.mdx +++ b/docs/models/operations/getbatchesglobals.mdx @@ -14,6 +14,6 @@ let value: GetBatchesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getbatchesrequest.mdx b/docs/models/operations/getbatchesrequest.mdx index 94bd6f94d..cd58650f6 100644 --- a/docs/models/operations/getbatchesrequest.mdx +++ b/docs/models/operations/getbatchesrequest.mdx @@ -16,7 +16,7 @@ let value: GetBatchesRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The batch job id returned from submit. | batch_abc123 | \ No newline at end of file diff --git a/docs/models/operations/getbenchmarksglobals.mdx b/docs/models/operations/getbenchmarksglobals.mdx index b4229c0f8..efdb29373 100644 --- a/docs/models/operations/getbenchmarksglobals.mdx +++ b/docs/models/operations/getbenchmarksglobals.mdx @@ -14,6 +14,6 @@ let value: GetBenchmarksGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getbenchmarksrequest.mdx b/docs/models/operations/getbenchmarksrequest.mdx index 95266880d..cad1a6158 100644 --- a/docs/models/operations/getbenchmarksrequest.mdx +++ b/docs/models/operations/getbenchmarksrequest.mdx @@ -16,15 +16,15 @@ let value: GetBenchmarksRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `source` | [operations.Source](../../models/operations/source.mdx) | :heavy_minus_sign: | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | -| `taskType` | [operations.TaskType](../../models/operations/tasktype.mdx) | :heavy_minus_sign: | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. `search` returns OpenRouter search benchmark results only. | coding | -| `benchmarkType` | [operations.BenchmarkType](../../models/operations/benchmarktype.mdx) | :heavy_minus_sign: | Return results for one exact OpenRouter benchmark. A `search_*` value narrows the response to search results only; a classic value narrows the OpenRouter items and leaves other sources' items as they are. | search_widesearch | -| `includeRunConfig` | *boolean* | :heavy_minus_sign: | Search benchmarks only: include the published lane configuration whitelist in each search item. Defaults to false. The whitelist is limited to agent turn count, reasoning effort, and temperature so future harness configuration changes do not change the public contract. | true | -| `searchEngine` | *string* | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the search engine used. | exa | -| `searchSurface` | [operations.SearchSurface](../../models/operations/searchsurface.mdx) | :heavy_minus_sign: | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | -| `arena` | [operations.Arena](../../models/operations/arena.mdx) | :heavy_minus_sign: | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | -| `category` | *string* | :heavy_minus_sign: | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `source` | [operations.Source](../../models/operations/source.mdx) | ➖ | Benchmark source to query. Determines the shape of the returned items. When omitted, returns results from all sources. | artificial-analysis | +| `taskType` | [operations.TaskType](../../models/operations/tasktype.mdx) | ➖ | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. `search` returns OpenRouter search benchmark results only. | coding | +| `benchmarkType` | [operations.BenchmarkType](../../models/operations/benchmarktype.mdx) | ➖ | Return results for one exact OpenRouter benchmark. A `search_*` value narrows the response to search results only; a classic value narrows the OpenRouter items and leaves other sources' items as they are. | search_widesearch | +| `includeRunConfig` | *boolean* | ➖ | Search benchmarks only: include the published lane configuration whitelist in each search item. Defaults to false. The whitelist is limited to agent turn count, reasoning effort, and temperature so future harness configuration changes do not change the public contract. | true | +| `searchEngine` | *string* | ➖ | OpenRouter search benchmarks only: filter by the search engine used. | exa | +| `searchSurface` | [operations.SearchSurface](../../models/operations/searchsurface.mdx) | ➖ | OpenRouter search benchmarks only: filter by the request surface the lane ran on. | server-tool | +| `arena` | [operations.Arena](../../models/operations/arena.mdx) | ➖ | Design Arena only: arena to query. Defaults to `models` when source is `design-arena`. | models | +| `category` | *string* | ➖ | Design Arena only: category within the arena (e.g. `codecategories`, `uicomponent`, `gamedev`, `3d`, `dataviz`, `image`, `video`, `svg`). When omitted, returns all categories. | codecategories | +| `maxResults` | *number* | ➖ | Maximum number of items to return. When omitted, all matching results are returned. | 50 | \ No newline at end of file diff --git a/docs/models/operations/getbyokkeyglobals.mdx b/docs/models/operations/getbyokkeyglobals.mdx index 3430985fb..d5c923f39 100644 --- a/docs/models/operations/getbyokkeyglobals.mdx +++ b/docs/models/operations/getbyokkeyglobals.mdx @@ -14,6 +14,6 @@ let value: GetBYOKKeyGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getbyokkeyrequest.mdx b/docs/models/operations/getbyokkeyrequest.mdx index 5f08de352..ef2317f0a 100644 --- a/docs/models/operations/getbyokkeyrequest.mdx +++ b/docs/models/operations/getbyokkeyrequest.mdx @@ -16,7 +16,7 @@ let value: GetBYOKKeyRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | \ No newline at end of file diff --git a/docs/models/operations/getcontainerfileglobals.mdx b/docs/models/operations/getcontainerfileglobals.mdx index a3ac6c389..3f8d84c99 100644 --- a/docs/models/operations/getcontainerfileglobals.mdx +++ b/docs/models/operations/getcontainerfileglobals.mdx @@ -14,6 +14,6 @@ let value: GetContainerFileGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getcontainerfilerequest.mdx b/docs/models/operations/getcontainerfilerequest.mdx index 39247153d..9f78c866d 100644 --- a/docs/models/operations/getcontainerfilerequest.mdx +++ b/docs/models/operations/getcontainerfilerequest.mdx @@ -17,8 +17,8 @@ let value: GetContainerFileRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `containerId` | *string* | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `fileId` | *string* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `containerId` | *string* | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `fileId` | *string* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/getcreditsdata.mdx b/docs/models/operations/getcreditsdata.mdx index ff4dab7be..70ecef21f 100644 --- a/docs/models/operations/getcreditsdata.mdx +++ b/docs/models/operations/getcreditsdata.mdx @@ -17,5 +17,5 @@ let value: GetCreditsData = { | Field | Type | Required | Description | Example | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- | -| `totalCredits` | *number* | :heavy_check_mark: | Total credits purchased | 100.5 | -| `totalUsage` | *number* | :heavy_check_mark: | Total credits used | 25.75 | \ No newline at end of file +| `totalCredits` | *number* | ✅ | Total credits purchased | 100.5 | +| `totalUsage` | *number* | ✅ | Total credits used | 25.75 | \ No newline at end of file diff --git a/docs/models/operations/getcreditsglobals.mdx b/docs/models/operations/getcreditsglobals.mdx index 75ed781b4..f639dc7a1 100644 --- a/docs/models/operations/getcreditsglobals.mdx +++ b/docs/models/operations/getcreditsglobals.mdx @@ -14,6 +14,6 @@ let value: GetCreditsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getcreditsrequest.mdx b/docs/models/operations/getcreditsrequest.mdx index 6bda02551..5bc217b03 100644 --- a/docs/models/operations/getcreditsrequest.mdx +++ b/docs/models/operations/getcreditsrequest.mdx @@ -14,6 +14,6 @@ let value: GetCreditsRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getcreditsresponse.mdx b/docs/models/operations/getcreditsresponse.mdx index 1b5382b91..2006929f2 100644 --- a/docs/models/operations/getcreditsresponse.mdx +++ b/docs/models/operations/getcreditsresponse.mdx @@ -21,4 +21,4 @@ let value: GetCreditsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data` | [operations.GetCreditsData](../../models/operations/getcreditsdata.mdx) | :heavy_check_mark: | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file +| `data` | [operations.GetCreditsData](../../models/operations/getcreditsdata.mdx) | ✅ | N/A | \{
"total_credits": 100.5,
"total_usage": 25.75
} | \ No newline at end of file diff --git a/docs/models/operations/getcurrentkeydata.mdx b/docs/models/operations/getcurrentkeydata.mdx index dd8e8471b..6a6ad0de0 100644 --- a/docs/models/operations/getcurrentkeydata.mdx +++ b/docs/models/operations/getcurrentkeydata.mdx @@ -51,26 +51,26 @@ let value: GetCurrentKeyData = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDataRegions` | [operations.AllowedDataRegion](../../models/operations/alloweddataregion.mdx)[] | :heavy_check_mark: | Data regions permitted for this API key by the guardrail policies on the key and the account regional-routing entitlement. Empty when no region is permitted. Reflects region policy only: other key restrictions, such as management keys being blocked from inference, still apply. | [
"global",
"europe",
"us"
] | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `freeModelDailyRequests` | [models.FreeModelDailyRequests](../../models/freemodeldailyrequests.mdx) | :heavy_check_mark: | Free-model (`:free` variant) daily request quota for the account that owns the key. Reports the same counter and tier limit that free-model enforcement reads for accounts subject to the free-model limits; the counter resets at UTC midnight. Accounts and endpoints exempt from free-model limits, and BYOK requests, are not gated by it, so `remaining` is the tier policy rather than an enforced ceiling for them. | \{
"limit": 50,
"remaining": 38,
"used": 12
} | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `isFreeTier` | *boolean* | :heavy_check_mark: | Whether this is a free tier API key | false | -| `isManagementKey` | *boolean* | :heavy_check_mark: | Whether this is a management key | false | -| ~~`isProvisioningKey`~~ | *boolean* | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `organizationId` | *string* | :heavy_check_mark: | The ID of the organization that owns this API key, or null when an individual account owns it. | null | -| ~~`rateLimit`~~ | [operations.RateLimit](../../models/operations/ratelimit.mdx) | :heavy_check_mark: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Legacy rate limit information about a key. Will always return -1. | \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
} | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspaceId` | *string* | :heavy_check_mark: | The ID of the workspace this API key spends in, or null when no active workspace resolved for it, for example because the key's workspace was deleted. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `allowedDataRegions` | [operations.AllowedDataRegion](../../models/operations/alloweddataregion.mdx)[] | ✅ | Data regions permitted for this API key by the guardrail policies on the key and the account regional-routing entitlement. Empty when no region is permitted. Reflects region policy only: other key restrictions, such as management keys being blocked from inference, still apply. | [
"global",
"europe",
"us"
] | +| `byokUsage` | *number* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byokUsageDaily` | *number* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byokUsageMonthly` | *number* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byokUsageWeekly` | *number* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `creatorUserId` | *string* | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `freeModelDailyRequests` | [models.FreeModelDailyRequests](../../models/freemodeldailyrequests.mdx) | ✅ | Free-model (`:free` variant) daily request quota for the account that owns the key. Reports the same counter and tier limit that free-model enforcement reads for accounts subject to the free-model limits; the counter resets at UTC midnight. Accounts and endpoints exempt from free-model limits, and BYOK requests, are not gated by it, so `remaining` is the tier policy rather than an enforced ceiling for them. | \{
"limit": 50,
"remaining": 38,
"used": 12
} | +| `includeByokInLimit` | *boolean* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `isFreeTier` | *boolean* | ✅ | Whether this is a free tier API key | false | +| `isManagementKey` | *boolean* | ✅ | Whether this is a management key | false | +| ~~`isProvisioningKey`~~ | *boolean* | ✅ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Whether this is a management key | false | +| `label` | *string* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `limit` | *number* | ✅ | Spending limit for the API key in USD | 100 | +| `limitRemaining` | *number* | ✅ | Remaining spending limit in USD | 74.5 | +| `limitReset` | *string* | ✅ | Type of limit reset for the API key | monthly | +| `organizationId` | *string* | ✅ | The ID of the organization that owns this API key, or null when an individual account owns it. | null | +| ~~`rateLimit`~~ | [operations.RateLimit](../../models/operations/ratelimit.mdx) | ✅ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Legacy rate limit information about a key. Will always return -1. | \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
} | +| `usage` | *number* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usageDaily` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usageMonthly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usageWeekly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspaceId` | *string* | ✅ | The ID of the workspace this API key spends in, or null when no active workspace resolved for it, for example because the key's workspace was deleted. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/getcurrentkeyglobals.mdx b/docs/models/operations/getcurrentkeyglobals.mdx index 6e954421a..048007c62 100644 --- a/docs/models/operations/getcurrentkeyglobals.mdx +++ b/docs/models/operations/getcurrentkeyglobals.mdx @@ -14,6 +14,6 @@ let value: GetCurrentKeyGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getcurrentkeyrequest.mdx b/docs/models/operations/getcurrentkeyrequest.mdx index 8a69d464c..7fc4427a2 100644 --- a/docs/models/operations/getcurrentkeyrequest.mdx +++ b/docs/models/operations/getcurrentkeyrequest.mdx @@ -14,6 +14,6 @@ let value: GetCurrentKeyRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getcurrentkeyresponse.mdx b/docs/models/operations/getcurrentkeyresponse.mdx index 026d3311f..16a6c4fdf 100644 --- a/docs/models/operations/getcurrentkeyresponse.mdx +++ b/docs/models/operations/getcurrentkeyresponse.mdx @@ -53,4 +53,4 @@ let value: GetCurrentKeyResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetCurrentKeyData](../../models/operations/getcurrentkeydata.mdx) | :heavy_check_mark: | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"expires_at": "2027-12-31T23:59:59Z",
"free_model_daily_requests": \{
"limit": 50,
"remaining": 38,
"used": 12
},
"include_byok_in_limit": false,
"is_free_tier": false,
"is_management_key": false,
"is_provisioning_key": false,
"label": "sk-or-v1-au7...890",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"rate_limit": \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
},
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5
} | \ No newline at end of file +| `data` | [operations.GetCurrentKeyData](../../models/operations/getcurrentkeydata.mdx) | ✅ | Current API key information | \{
"allowed_data_regions": [
"global",
"europe",
"us"
],
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"expires_at": "2027-12-31T23:59:59Z",
"free_model_daily_requests": \{
"limit": 50,
"remaining": 38,
"used": 12
},
"include_byok_in_limit": false,
"is_free_tier": false,
"is_management_key": false,
"is_provisioning_key": false,
"label": "sk-or-v1-au7...890",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"rate_limit": \{
"interval": "1h",
"note": "This field is deprecated and safe to ignore.",
"requests": 1000
},
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5
} | \ No newline at end of file diff --git a/docs/models/operations/getenduserglobals.mdx b/docs/models/operations/getenduserglobals.mdx index b391ec73e..0e67e1a35 100644 --- a/docs/models/operations/getenduserglobals.mdx +++ b/docs/models/operations/getenduserglobals.mdx @@ -14,6 +14,6 @@ let value: GetEndUserGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getenduserrequest.mdx b/docs/models/operations/getenduserrequest.mdx index 7238fb709..74e32c637 100644 --- a/docs/models/operations/getenduserrequest.mdx +++ b/docs/models/operations/getenduserrequest.mdx @@ -16,7 +16,7 @@ let value: GetEndUserRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `user` | *string* | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `user` | *string* | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | \ No newline at end of file diff --git a/docs/models/operations/getfilemetadataglobals.mdx b/docs/models/operations/getfilemetadataglobals.mdx index 70693fdda..39b70bb62 100644 --- a/docs/models/operations/getfilemetadataglobals.mdx +++ b/docs/models/operations/getfilemetadataglobals.mdx @@ -14,6 +14,6 @@ let value: GetFileMetadataGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getfilemetadatarequest.mdx b/docs/models/operations/getfilemetadatarequest.mdx index 1f008ac5c..e84c6e17f 100644 --- a/docs/models/operations/getfilemetadatarequest.mdx +++ b/docs/models/operations/getfilemetadatarequest.mdx @@ -16,9 +16,9 @@ let value: GetFileMetadataRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `fileId` | *string* | :heavy_check_mark: | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `fileId` | *string* | ✅ | N/A | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `workspaceId` | *string* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | \ No newline at end of file diff --git a/docs/models/operations/getgenerationglobals.mdx b/docs/models/operations/getgenerationglobals.mdx index a718ba231..97b9ca169 100644 --- a/docs/models/operations/getgenerationglobals.mdx +++ b/docs/models/operations/getgenerationglobals.mdx @@ -14,6 +14,6 @@ let value: GetGenerationGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getgenerationrequest.mdx b/docs/models/operations/getgenerationrequest.mdx index 99bb807e3..eaf9e53b7 100644 --- a/docs/models/operations/getgenerationrequest.mdx +++ b/docs/models/operations/getgenerationrequest.mdx @@ -16,7 +16,7 @@ let value: GetGenerationRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/models/operations/getguardrailglobals.mdx b/docs/models/operations/getguardrailglobals.mdx index 1880600b1..2ec3345b2 100644 --- a/docs/models/operations/getguardrailglobals.mdx +++ b/docs/models/operations/getguardrailglobals.mdx @@ -14,6 +14,6 @@ let value: GetGuardrailGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getguardrailrequest.mdx b/docs/models/operations/getguardrailrequest.mdx index 091ad47f1..a65144972 100644 --- a/docs/models/operations/getguardrailrequest.mdx +++ b/docs/models/operations/getguardrailrequest.mdx @@ -16,7 +16,7 @@ let value: GetGuardrailRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/getinterndaemonaccessglobals.mdx b/docs/models/operations/getinterndaemonaccessglobals.mdx index 7db66ea68..f30f317f8 100644 --- a/docs/models/operations/getinterndaemonaccessglobals.mdx +++ b/docs/models/operations/getinterndaemonaccessglobals.mdx @@ -14,6 +14,6 @@ let value: GetInternDaemonAccessGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getinterndaemonaccessrequest.mdx b/docs/models/operations/getinterndaemonaccessrequest.mdx index e1d3429dc..9e4da144a 100644 --- a/docs/models/operations/getinterndaemonaccessrequest.mdx +++ b/docs/models/operations/getinterndaemonaccessrequest.mdx @@ -16,7 +16,7 @@ let value: GetInternDaemonAccessRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/getinterndaemonglobals.mdx b/docs/models/operations/getinterndaemonglobals.mdx index c9ae9a91b..19b5b53f9 100644 --- a/docs/models/operations/getinterndaemonglobals.mdx +++ b/docs/models/operations/getinterndaemonglobals.mdx @@ -14,6 +14,6 @@ let value: GetInternDaemonGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getinterndaemonrequest.mdx b/docs/models/operations/getinterndaemonrequest.mdx index 07b1fb851..7ac41ca76 100644 --- a/docs/models/operations/getinterndaemonrequest.mdx +++ b/docs/models/operations/getinterndaemonrequest.mdx @@ -16,7 +16,7 @@ let value: GetInternDaemonRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/getinternglobals.mdx b/docs/models/operations/getinternglobals.mdx index f7df614b8..bb138c805 100644 --- a/docs/models/operations/getinternglobals.mdx +++ b/docs/models/operations/getinternglobals.mdx @@ -14,6 +14,6 @@ let value: GetInternGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getinternrequest.mdx b/docs/models/operations/getinternrequest.mdx index 9b287a4de..480a333c9 100644 --- a/docs/models/operations/getinternrequest.mdx +++ b/docs/models/operations/getinternrequest.mdx @@ -16,7 +16,7 @@ let value: GetInternRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/getkeydata.mdx b/docs/models/operations/getkeydata.mdx index 4f499f617..4df2b950f 100644 --- a/docs/models/operations/getkeydata.mdx +++ b/docs/models/operations/getkeydata.mdx @@ -39,26 +39,26 @@ let value: GetKeyData = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `externalUser` | *string* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `lastUsedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byokUsage` | *number* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byokUsageDaily` | *number* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byokUsageMonthly` | *number* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byokUsageWeekly` | *number* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creatorUserId` | *string* | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `disabled` | *boolean* | ✅ | Whether the API key is disabled | false | +| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `externalUser` | *string* | ✅ | Partner's end-user identifier used for attribution. | null | +| `hash` | *string* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `includeByokInLimit` | *boolean* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `label` | *string* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `lastUsedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `limit` | *number* | ✅ | Spending limit for the API key in USD | 100 | +| `limitRemaining` | *number* | ✅ | Remaining spending limit in USD | 74.5 | +| `limitReset` | *string* | ✅ | Type of limit reset for the API key | monthly | +| `name` | *string* | ✅ | Name of the API key | My Production Key | +| `updatedAt` | *string* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *number* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usageDaily` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usageMonthly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usageWeekly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspaceId` | *string* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/getkeyglobals.mdx b/docs/models/operations/getkeyglobals.mdx index 1c8e0885f..ae9318ec0 100644 --- a/docs/models/operations/getkeyglobals.mdx +++ b/docs/models/operations/getkeyglobals.mdx @@ -14,6 +14,6 @@ let value: GetKeyGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getkeyrequest.mdx b/docs/models/operations/getkeyrequest.mdx index 690e01c8b..112055707 100644 --- a/docs/models/operations/getkeyrequest.mdx +++ b/docs/models/operations/getkeyrequest.mdx @@ -16,7 +16,7 @@ let value: GetKeyRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `hash` | *string* | ✅ | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | \ No newline at end of file diff --git a/docs/models/operations/getkeyresponse.mdx b/docs/models/operations/getkeyresponse.mdx index f622496bd..5638c347e 100644 --- a/docs/models/operations/getkeyresponse.mdx +++ b/docs/models/operations/getkeyresponse.mdx @@ -41,4 +41,4 @@ let value: GetKeyResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.GetKeyData](../../models/operations/getkeydata.mdx) | :heavy_check_mark: | The API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `data` | [operations.GetKeyData](../../models/operations/getkeydata.mdx) | ✅ | The API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/operations/getmodelglobals.mdx b/docs/models/operations/getmodelglobals.mdx index e36dbe7db..c07a0c36b 100644 --- a/docs/models/operations/getmodelglobals.mdx +++ b/docs/models/operations/getmodelglobals.mdx @@ -14,6 +14,6 @@ let value: GetModelGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getmodelrequest.mdx b/docs/models/operations/getmodelrequest.mdx index ff8dd90db..c9c78d49d 100644 --- a/docs/models/operations/getmodelrequest.mdx +++ b/docs/models/operations/getmodelrequest.mdx @@ -17,8 +17,8 @@ let value: GetModelRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *string* | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | *string* | :heavy_check_mark: | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `author` | *string* | ✅ | The author/organization of the model | openai | +| `slug` | *string* | ✅ | The model slug, optionally including a variant suffix (e.g. gpt-4 or gpt-4:free) | gpt-4 | \ No newline at end of file diff --git a/docs/models/operations/getmodelsglobals.mdx b/docs/models/operations/getmodelsglobals.mdx index 285fd2a0b..fc982aa92 100644 --- a/docs/models/operations/getmodelsglobals.mdx +++ b/docs/models/operations/getmodelsglobals.mdx @@ -14,6 +14,6 @@ let value: GetModelsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getmodelsrequest.mdx b/docs/models/operations/getmodelsrequest.mdx index 8e7e0471e..42e7be686 100644 --- a/docs/models/operations/getmodelsrequest.mdx +++ b/docs/models/operations/getmodelsrequest.mdx @@ -14,35 +14,35 @@ let value: GetModelsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `category` | [operations.GetModelsCategory](../../models/operations/getmodelscategory.mdx) | :heavy_minus_sign: | Filter models by use case category | programming | -| `supportedParameters` | *string* | :heavy_minus_sign: | Filter models by supported parameter (comma-separated) | temperature | -| `outputModalities` | *string* | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | -| `sort` | [operations.GetModelsSort](../../models/operations/getmodelssort.mdx) | :heavy_minus_sign: | Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. | newest | -| `q` | *string* | :heavy_minus_sign: | Free-text search by model name or slug. | gpt-4 | -| `inputModalities` | *string* | :heavy_minus_sign: | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | -| `context` | *number* | :heavy_minus_sign: | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | -| `minPrice` | *number* | :heavy_minus_sign: | Minimum prompt price in $/M tokens. | 0 | -| `maxPrice` | *number* | :heavy_minus_sign: | Maximum prompt price in $/M tokens. | 10 | -| `arch` | *string* | :heavy_minus_sign: | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | -| `modelAuthors` | *string* | :heavy_minus_sign: | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | -| `providers` | *string* | :heavy_minus_sign: | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | -| `distillable` | [operations.Distillable](../../models/operations/distillable.mdx) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | -| `zdr` | [operations.Zdr](../../models/operations/zdr.mdx) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | -| `region` | [operations.Region](../../models/operations/region.mdx) | :heavy_minus_sign: | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | -| `minOutputPrice` | *number* | :heavy_minus_sign: | Minimum completion (output) price in $/M tokens. | 0 | -| `maxOutputPrice` | *number* | :heavy_minus_sign: | Maximum completion (output) price in $/M tokens. | 10 | -| `minAgeDays` | *number* | :heavy_minus_sign: | Minimum model age in days since its creation date. | 0 | -| `maxAgeDays` | *number* | :heavy_minus_sign: | Maximum model age in days since its creation date. | 90 | -| `minIntelligenceIndex` | *number* | :heavy_minus_sign: | Minimum Artificial Analysis intelligence index. | 50 | -| `maxIntelligenceIndex` | *number* | :heavy_minus_sign: | Maximum Artificial Analysis intelligence index. | 100 | -| `minCodingIndex` | *number* | :heavy_minus_sign: | Minimum Artificial Analysis coding index. | 50 | -| `maxCodingIndex` | *number* | :heavy_minus_sign: | Maximum Artificial Analysis coding index. | 100 | -| `minAgenticIndex` | *number* | :heavy_minus_sign: | Minimum Artificial Analysis agentic index. | 50 | -| `maxAgenticIndex` | *number* | :heavy_minus_sign: | Maximum Artificial Analysis agentic index. | 100 | -| `minToolSuccessRate` | *number* | :heavy_minus_sign: | Minimum tool-calling success rate, as a fraction in [0, 1] (e.g. 0.9 = 90% of requests finishing with a tool_calls finish reason). | 0.9 | -| `maxToolSuccessRate` | *number* | :heavy_minus_sign: | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `category` | [operations.GetModelsCategory](../../models/operations/getmodelscategory.mdx) | ➖ | Filter models by use case category | programming | +| `supportedParameters` | *string* | ➖ | Filter models by supported parameter (comma-separated) | temperature | +| `outputModalities` | *string* | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | +| `sort` | [operations.GetModelsSort](../../models/operations/getmodelssort.mdx) | ➖ | Sort the returned models server-side. Prefer this over fetching the full list and sorting client-side. Options: pricing-low-to-high, pricing-high-to-low (average prompt/completion price), context-high-to-low (context length), throughput-high-to-low, latency-low-to-high (recent median performance), most-popular, top-weekly (tokens processed in the last week), newest (creation date), intelligence-high-to-low, coding-high-to-low, agentic-high-to-low (Artificial Analysis indices), design-arena-elo-high-to-low (best Design Arena ELO across arenas). Models without a score for the chosen benchmark are placed last. When omitted, the existing default ordering is preserved. | newest | +| `q` | *string* | ➖ | Free-text search by model name or slug. | gpt-4 | +| `inputModalities` | *string* | ➖ | Filter models by input modality. Comma-separated list of: text, image, audio, file. | text,image | +| `context` | *number* | ➖ | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | +| `minPrice` | *number* | ➖ | Minimum prompt price in $/M tokens. | 0 | +| `maxPrice` | *number* | ➖ | Maximum prompt price in $/M tokens. | 10 | +| `arch` | *string* | ➖ | Filter models by architecture/model family (e.g. GPT, Claude, Gemini, Llama). | GPT | +| `modelAuthors` | *string* | ➖ | Filter models by the organization that created the model. Comma-separated list of author slugs. | openai,anthropic | +| `providers` | *string* | ➖ | Filter models by hosting provider. Comma-separated list of provider names. | OpenAI,Anthropic | +| `distillable` | [operations.Distillable](../../models/operations/distillable.mdx) | ➖ | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | +| `zdr` | [operations.Zdr](../../models/operations/zdr.mdx) | ➖ | When set to "true", return only models with zero data retention endpoints. | true | +| `region` | [operations.Region](../../models/operations/region.mdx) | ➖ | Filter to models with endpoints in the given data region ("eu" or "us"). | eu | +| `minOutputPrice` | *number* | ➖ | Minimum completion (output) price in $/M tokens. | 0 | +| `maxOutputPrice` | *number* | ➖ | Maximum completion (output) price in $/M tokens. | 10 | +| `minAgeDays` | *number* | ➖ | Minimum model age in days since its creation date. | 0 | +| `maxAgeDays` | *number* | ➖ | Maximum model age in days since its creation date. | 90 | +| `minIntelligenceIndex` | *number* | ➖ | Minimum Artificial Analysis intelligence index. | 50 | +| `maxIntelligenceIndex` | *number* | ➖ | Maximum Artificial Analysis intelligence index. | 100 | +| `minCodingIndex` | *number* | ➖ | Minimum Artificial Analysis coding index. | 50 | +| `maxCodingIndex` | *number* | ➖ | Maximum Artificial Analysis coding index. | 100 | +| `minAgenticIndex` | *number* | ➖ | Minimum Artificial Analysis agentic index. | 50 | +| `maxAgenticIndex` | *number* | ➖ | Maximum Artificial Analysis agentic index. | 100 | +| `minToolSuccessRate` | *number* | ➖ | Minimum tool-calling success rate, as a fraction in [0, 1] (e.g. 0.9 = 90% of requests finishing with a tool_calls finish reason). | 0.9 | +| `maxToolSuccessRate` | *number* | ➖ | Maximum tool-calling success rate, as a fraction in [0, 1]. | 1 | \ No newline at end of file diff --git a/docs/models/operations/getmodelsresponse.mdx b/docs/models/operations/getmodelsresponse.mdx index 8b64ea1a6..718ae4d1b 100644 --- a/docs/models/operations/getmodelsresponse.mdx +++ b/docs/models/operations/getmodelsresponse.mdx @@ -59,4 +59,4 @@ let value: GetModelsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ModelsListResponse](../../models/modelslistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file +| `result` | [models.ModelsListResponse](../../models/modelslistresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/getobservabilitydestinationglobals.mdx b/docs/models/operations/getobservabilitydestinationglobals.mdx index 97f93af1b..7735ee16e 100644 --- a/docs/models/operations/getobservabilitydestinationglobals.mdx +++ b/docs/models/operations/getobservabilitydestinationglobals.mdx @@ -14,6 +14,6 @@ let value: GetObservabilityDestinationGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getobservabilitydestinationrequest.mdx b/docs/models/operations/getobservabilitydestinationrequest.mdx index 85d776e24..55cc7ec5c 100644 --- a/docs/models/operations/getobservabilitydestinationrequest.mdx +++ b/docs/models/operations/getobservabilitydestinationrequest.mdx @@ -16,7 +16,7 @@ let value: GetObservabilityDestinationRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | \ No newline at end of file diff --git a/docs/models/operations/getorganizationsettingsglobals.mdx b/docs/models/operations/getorganizationsettingsglobals.mdx index 8a06dd3e1..fd46008cf 100644 --- a/docs/models/operations/getorganizationsettingsglobals.mdx +++ b/docs/models/operations/getorganizationsettingsglobals.mdx @@ -14,6 +14,6 @@ let value: GetOrganizationSettingsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getorganizationsettingsrequest.mdx b/docs/models/operations/getorganizationsettingsrequest.mdx index 10ef15761..e1f2cca11 100644 --- a/docs/models/operations/getorganizationsettingsrequest.mdx +++ b/docs/models/operations/getorganizationsettingsrequest.mdx @@ -14,6 +14,6 @@ let value: GetOrganizationSettingsRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getorganizationsettingsresponse.mdx b/docs/models/operations/getorganizationsettingsresponse.mdx index 75a3d5fc9..dbedab69e 100644 --- a/docs/models/operations/getorganizationsettingsresponse.mdx +++ b/docs/models/operations/getorganizationsettingsresponse.mdx @@ -21,4 +21,4 @@ let value: GetOrganizationSettingsResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [models.OrganizationSettings](../../models/organizationsettings.mdx) | :heavy_check_mark: | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file +| `data` | [models.OrganizationSettings](../../models/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file diff --git a/docs/models/operations/getpresetglobals.mdx b/docs/models/operations/getpresetglobals.mdx index 08e54ab19..725b253e9 100644 --- a/docs/models/operations/getpresetglobals.mdx +++ b/docs/models/operations/getpresetglobals.mdx @@ -14,6 +14,6 @@ let value: GetPresetGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getpresetrequest.mdx b/docs/models/operations/getpresetrequest.mdx index 3f254fb53..6df89f22f 100644 --- a/docs/models/operations/getpresetrequest.mdx +++ b/docs/models/operations/getpresetrequest.mdx @@ -16,7 +16,7 @@ let value: GetPresetRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *string* | ✅ | URL-safe slug identifying the preset. | my-preset | \ No newline at end of file diff --git a/docs/models/operations/getpresetversionglobals.mdx b/docs/models/operations/getpresetversionglobals.mdx index d87be5dec..52fa9bfcb 100644 --- a/docs/models/operations/getpresetversionglobals.mdx +++ b/docs/models/operations/getpresetversionglobals.mdx @@ -14,6 +14,6 @@ let value: GetPresetVersionGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getpresetversionrequest.mdx b/docs/models/operations/getpresetversionrequest.mdx index 4b0ffbd7b..01cd14eda 100644 --- a/docs/models/operations/getpresetversionrequest.mdx +++ b/docs/models/operations/getpresetversionrequest.mdx @@ -17,8 +17,8 @@ let value: GetPresetVersionRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `version` | *string* | :heavy_check_mark: | Version number of the preset. | 1 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *string* | ✅ | URL-safe slug identifying the preset. | my-preset | +| `version` | *string* | ✅ | Version number of the preset. | 1 | \ No newline at end of file diff --git a/docs/models/operations/getprivateendpointglobals.mdx b/docs/models/operations/getprivateendpointglobals.mdx index 9aff82686..17f65be37 100644 --- a/docs/models/operations/getprivateendpointglobals.mdx +++ b/docs/models/operations/getprivateendpointglobals.mdx @@ -14,6 +14,6 @@ let value: GetPrivateEndpointGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getprivateendpointrequest.mdx b/docs/models/operations/getprivateendpointrequest.mdx index 4a9fee9c7..e93e91fde 100644 --- a/docs/models/operations/getprivateendpointrequest.mdx +++ b/docs/models/operations/getprivateendpointrequest.mdx @@ -16,7 +16,7 @@ let value: GetPrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | \ No newline at end of file diff --git a/docs/models/operations/getrankingsdailyglobals.mdx b/docs/models/operations/getrankingsdailyglobals.mdx index 6fdb8733c..05635f803 100644 --- a/docs/models/operations/getrankingsdailyglobals.mdx +++ b/docs/models/operations/getrankingsdailyglobals.mdx @@ -14,6 +14,6 @@ let value: GetRankingsDailyGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getrankingsdailyrequest.mdx b/docs/models/operations/getrankingsdailyrequest.mdx index a8d815b3d..249cabdc4 100644 --- a/docs/models/operations/getrankingsdailyrequest.mdx +++ b/docs/models/operations/getrankingsdailyrequest.mdx @@ -14,13 +14,13 @@ let value: GetRankingsDailyRequest = {}; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `startDate` | *string* | :heavy_minus_sign: | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | -| `endDate` | *string* | :heavy_minus_sign: | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | -| `period` | [operations.Period](../../models/operations/period.mdx) | :heavy_minus_sign: | Time grain of each row. `day` (default) returns the per-UTC-day series; `week` buckets by ISO week start; `month` buckets by month start. With `category` or `language_type` only `week` (default) and `month` are available — `day` is rejected with a 400 because those datasets are aggregated weekly. For those sampled datasets `period=month` buckets each week by its week-start month, so totals are approximate at month boundaries. | day | -| `modality` | [operations.Modality](../../models/operations/modality.mdx) | :heavy_minus_sign: | Restrict to models for a modality surface: `text` / `image_output` match output modality, `image` / `audio` match input modality, and `tool_calling` keeps only rows that recorded at least one tool call. Exact dataset — cannot be combined with `category` or `language_type`. | text | -| `contextBucket` | [operations.ContextBucket](../../models/operations/contextbucket.mdx) | :heavy_minus_sign: | Restrict to requests whose context length falls in this bucket (`1K`, `10K`, `100K`, `1M`, or `10M`). Exact dataset — cannot be combined with `category` or `language_type`. | 100K | -| `category` | [operations.GetRankingsDailyCategory](../../models/operations/getrankingsdailycategory.mdx) | :heavy_minus_sign: | Restrict to a use-case category (e.g. `programming`, `roleplay`). Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `language_type`. | programming | -| `languageType` | [operations.LanguageType](../../models/operations/languagetype.mdx) | :heavy_minus_sign: | Restrict to natural-language or programming-language tagged activity. Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `category`. | natural | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `startDate` | *string* | ➖ | Start of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to 30 days before `end_date`. The dataset begins at 2025-01-01; earlier values are clamped forward to that floor and the resolved value is echoed in `meta.start_date`. | 2026-04-12 | +| `endDate` | *string* | ➖ | End of the date window in YYYY-MM-DD (UTC), inclusive. Defaults to the most recent completed UTC day. Must be on or after 2025-01-01; earlier values are rejected with a 400. | 2026-05-11 | +| `period` | [operations.Period](../../models/operations/period.mdx) | ➖ | Time grain of each row. `day` (default) returns the per-UTC-day series; `week` buckets by ISO week start; `month` buckets by month start. With `category` or `language_type` only `week` (default) and `month` are available — `day` is rejected with a 400 because those datasets are aggregated weekly. For those sampled datasets `period=month` buckets each week by its week-start month, so totals are approximate at month boundaries. | day | +| `modality` | [operations.Modality](../../models/operations/modality.mdx) | ➖ | Restrict to models for a modality surface: `text` / `image_output` match output modality, `image` / `audio` match input modality, and `tool_calling` keeps only rows that recorded at least one tool call. Exact dataset — cannot be combined with `category` or `language_type`. | text | +| `contextBucket` | [operations.ContextBucket](../../models/operations/contextbucket.mdx) | ➖ | Restrict to requests whose context length falls in this bucket (`1K`, `10K`, `100K`, `1M`, or `10M`). Exact dataset — cannot be combined with `category` or `language_type`. | 100K | +| `category` | [operations.GetRankingsDailyCategory](../../models/operations/getrankingsdailycategory.mdx) | ➖ | Restrict to a use-case category (e.g. `programming`, `roleplay`). Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `language_type`. | programming | +| `languageType` | [operations.LanguageType](../../models/operations/languagetype.mdx) | ➖ | Restrict to natural-language or programming-language tagged activity. Sourced from a sampled, upsampled dataset, so `total_tokens` is an estimate and is aggregated weekly (the trailing weekly bucket may include traffic past `end_date`). Cannot be combined with `modality`, `context_bucket`, or `category`. | natural | \ No newline at end of file diff --git a/docs/models/operations/getscimgroupmappingglobals.mdx b/docs/models/operations/getscimgroupmappingglobals.mdx index 1f8c3b91c..55d99e1b1 100644 --- a/docs/models/operations/getscimgroupmappingglobals.mdx +++ b/docs/models/operations/getscimgroupmappingglobals.mdx @@ -14,6 +14,6 @@ let value: GetScimGroupMappingGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getscimgroupmappingrequest.mdx b/docs/models/operations/getscimgroupmappingrequest.mdx index 3da57c247..e6b7c851e 100644 --- a/docs/models/operations/getscimgroupmappingrequest.mdx +++ b/docs/models/operations/getscimgroupmappingrequest.mdx @@ -16,7 +16,7 @@ let value: GetScimGroupMappingRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `id` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getscimsyncjobglobals.mdx b/docs/models/operations/getscimsyncjobglobals.mdx index e9c4294e7..7e958f25e 100644 --- a/docs/models/operations/getscimsyncjobglobals.mdx +++ b/docs/models/operations/getscimsyncjobglobals.mdx @@ -14,6 +14,6 @@ let value: GetScimSyncJobGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getscimsyncjobrequest.mdx b/docs/models/operations/getscimsyncjobrequest.mdx index 118fa00e3..f9ec0c3a5 100644 --- a/docs/models/operations/getscimsyncjobrequest.mdx +++ b/docs/models/operations/getscimsyncjobrequest.mdx @@ -16,7 +16,7 @@ let value: GetScimSyncJobRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `id` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getsessioncostglobals.mdx b/docs/models/operations/getsessioncostglobals.mdx index 5653ce764..d513713f7 100644 --- a/docs/models/operations/getsessioncostglobals.mdx +++ b/docs/models/operations/getsessioncostglobals.mdx @@ -14,6 +14,6 @@ let value: GetSessionCostGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getsessioncostrequest.mdx b/docs/models/operations/getsessioncostrequest.mdx index cd0db275b..daa2de993 100644 --- a/docs/models/operations/getsessioncostrequest.mdx +++ b/docs/models/operations/getsessioncostrequest.mdx @@ -14,11 +14,11 @@ let value: GetSessionCostRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `appSlug` | *string* | :heavy_minus_sign: | Filter to one published harness slug. | hermes-agent | -| `model` | *string* | :heavy_minus_sign: | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | -| `turnRange` | [operations.TurnRange](../../models/operations/turnrange.mdx) | :heavy_minus_sign: | Filter by the inclusive number of turns in a session. | 10-49-turns | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of cells to return (1-500). Defaults to 100. | 100 | -| `offset` | *number* | :heavy_minus_sign: | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `appSlug` | *string* | ➖ | Filter to one published harness slug. | hermes-agent | +| `model` | *string* | ➖ | Exact model permaslug filter. Works across all harness apps. | anthropic/claude-4.8-opus | +| `turnRange` | [operations.TurnRange](../../models/operations/turnrange.mdx) | ➖ | Filter by the inclusive number of turns in a session. | 10-49-turns | +| `limit` | *number* | ➖ | Maximum number of cells to return (1-500). Defaults to 100. | 100 | +| `offset` | *number* | ➖ | Number of sorted cells to skip (0-5000). Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/getsessioncostresponse.mdx b/docs/models/operations/getsessioncostresponse.mdx index 300e06978..405fd0737 100644 --- a/docs/models/operations/getsessioncostresponse.mdx +++ b/docs/models/operations/getsessioncostresponse.mdx @@ -32,4 +32,4 @@ let value: GetSessionCostResponse = { | Field | Type | Required | Description | | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `result` | [models.SessionCostResponse](../../models/sessioncostresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `result` | [models.SessionCostResponse](../../models/sessioncostresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/gettaskclassificationsglobals.mdx b/docs/models/operations/gettaskclassificationsglobals.mdx index cdd2dfee2..f47ec4d44 100644 --- a/docs/models/operations/gettaskclassificationsglobals.mdx +++ b/docs/models/operations/gettaskclassificationsglobals.mdx @@ -14,6 +14,6 @@ let value: GetTaskClassificationsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/gettaskclassificationsrequest.mdx b/docs/models/operations/gettaskclassificationsrequest.mdx index 9c26cc8ca..e0bbaa7c5 100644 --- a/docs/models/operations/gettaskclassificationsrequest.mdx +++ b/docs/models/operations/gettaskclassificationsrequest.mdx @@ -14,7 +14,7 @@ let value: GetTaskClassificationsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `window` | [operations.Window](../../models/operations/window.mdx) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `window` | [operations.Window](../../models/operations/window.mdx) | ➖ | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | \ No newline at end of file diff --git a/docs/models/operations/gettoolglobals.mdx b/docs/models/operations/gettoolglobals.mdx index b9e03e032..265c34d0a 100644 --- a/docs/models/operations/gettoolglobals.mdx +++ b/docs/models/operations/gettoolglobals.mdx @@ -14,6 +14,6 @@ let value: GetToolGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/gettoolrequest.mdx b/docs/models/operations/gettoolrequest.mdx index 1ac7f03a9..1674b3fd9 100644 --- a/docs/models/operations/gettoolrequest.mdx +++ b/docs/models/operations/gettoolrequest.mdx @@ -16,7 +16,7 @@ let value: GetToolRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `name` | *string* | :heavy_check_mark: | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `name` | *string* | ✅ | Canonical `openrouter:*` name or any accepted `tools[].type` alias | openrouter:web_search | \ No newline at end of file diff --git a/docs/models/operations/gettoolresponse.mdx b/docs/models/operations/gettoolresponse.mdx index a60af9601..a164742c8 100644 --- a/docs/models/operations/gettoolresponse.mdx +++ b/docs/models/operations/gettoolresponse.mdx @@ -16,5 +16,5 @@ let value: GetToolResponse = { | Field | Type | Required | Description | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `headers` | Record\ | :heavy_check_mark: | N/A | -| `result` | [models.GetToolResponse](../../models/gettoolresponse.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `headers` | Record\ | ✅ | N/A | +| `result` | [models.GetToolResponse](../../models/gettoolresponse.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/operations/gettoolsecurity.mdx b/docs/models/operations/gettoolsecurity.mdx index 036a1f3e8..b9d806ed4 100644 --- a/docs/models/operations/gettoolsecurity.mdx +++ b/docs/models/operations/gettoolsecurity.mdx @@ -16,4 +16,4 @@ let value: GetToolSecurity = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bearer` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/getuseractivityglobals.mdx b/docs/models/operations/getuseractivityglobals.mdx index 3aad2ab57..5fd218c89 100644 --- a/docs/models/operations/getuseractivityglobals.mdx +++ b/docs/models/operations/getuseractivityglobals.mdx @@ -14,6 +14,6 @@ let value: GetUserActivityGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getuseractivityrequest.mdx b/docs/models/operations/getuseractivityrequest.mdx index b51f30b72..51bb09339 100644 --- a/docs/models/operations/getuseractivityrequest.mdx +++ b/docs/models/operations/getuseractivityrequest.mdx @@ -14,11 +14,11 @@ let value: GetUserActivityRequest = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `date` | *string* | :heavy_minus_sign: | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | -| `apiKeyHash` | *string* | :heavy_minus_sign: | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | -| `userId` | *string* | :heavy_minus_sign: | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | -| `groupBy` | [operations.GroupBy](../../models/operations/groupby.mdx) | :heavy_minus_sign: | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | -| `workspaceId` | *string* | :heavy_minus_sign: | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `date` | *string* | ➖ | Filter by a single UTC date in the last 30 days (YYYY-MM-DD format). | 2025-08-24 | +| `apiKeyHash` | *string* | ➖ | Filter by API key hash (SHA-256 hex string, as returned by the keys API). | abc123def456... | +| `userId` | *string* | ➖ | Filter by org member user ID. Only applicable for organization accounts. | user_abc123 | +| `groupBy` | [operations.GroupBy](../../models/operations/groupby.mdx) | ➖ | Set to 'workspace' to split each row per workspace and include `workspace_id` on every item. Omitted by default, in which case rows are aggregated across workspaces (by date, model, and endpoint) and `workspace_id` is not returned — preserving the historical response shape. | workspace | +| `workspaceId` | *string* | ➖ | Filter by workspace ID (UUID). Returns only activity attributed to that workspace. The workspace must belong to the authenticated account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/getvideosglobals.mdx b/docs/models/operations/getvideosglobals.mdx index 41a1b52ef..ae642781c 100644 --- a/docs/models/operations/getvideosglobals.mdx +++ b/docs/models/operations/getvideosglobals.mdx @@ -14,6 +14,6 @@ let value: GetVideosGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getvideosrequest.mdx b/docs/models/operations/getvideosrequest.mdx index 3a9e06ab1..918e49a40 100644 --- a/docs/models/operations/getvideosrequest.mdx +++ b/docs/models/operations/getvideosrequest.mdx @@ -16,7 +16,7 @@ let value: GetVideosRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `jobId` | *string* | :heavy_check_mark: | N/A | job-abc123 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `jobId` | *string* | ✅ | N/A | job-abc123 | \ No newline at end of file diff --git a/docs/models/operations/getworkspacebudgetglobals.mdx b/docs/models/operations/getworkspacebudgetglobals.mdx index b340b8542..9193a9e1f 100644 --- a/docs/models/operations/getworkspacebudgetglobals.mdx +++ b/docs/models/operations/getworkspacebudgetglobals.mdx @@ -14,6 +14,6 @@ let value: GetWorkspaceBudgetGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getworkspacebudgetrequest.mdx b/docs/models/operations/getworkspacebudgetrequest.mdx index 2c7d852a0..767d49b35 100644 --- a/docs/models/operations/getworkspacebudgetrequest.mdx +++ b/docs/models/operations/getworkspacebudgetrequest.mdx @@ -17,8 +17,8 @@ let value: GetWorkspaceBudgetRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspaceRef` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [models.WorkspaceBudgetInterval](../../models/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspaceRef` | *string* | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [models.WorkspaceBudgetInterval](../../models/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | \ No newline at end of file diff --git a/docs/models/operations/getworkspaceglobals.mdx b/docs/models/operations/getworkspaceglobals.mdx index 674ec04a2..75377ce5f 100644 --- a/docs/models/operations/getworkspaceglobals.mdx +++ b/docs/models/operations/getworkspaceglobals.mdx @@ -14,6 +14,6 @@ let value: GetWorkspaceGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/getworkspacerequest.mdx b/docs/models/operations/getworkspacerequest.mdx index 9d0dc8b92..88135213d 100644 --- a/docs/models/operations/getworkspacerequest.mdx +++ b/docs/models/operations/getworkspacerequest.mdx @@ -16,7 +16,7 @@ let value: GetWorkspaceRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/models/operations/granularity.mdx b/docs/models/operations/granularity.mdx index e3b0c5ddf..9ea93e589 100644 --- a/docs/models/operations/granularity.mdx +++ b/docs/models/operations/granularity.mdx @@ -17,5 +17,5 @@ let value: Granularity = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `displayLabel` | *string* | :heavy_check_mark: | Human-readable label | Day | -| `name` | [operations.GranularityName](../../models/operations/granularityname.mdx) | :heavy_check_mark: | Granularity identifier | day | \ No newline at end of file +| `displayLabel` | *string* | ✅ | Human-readable label | Day | +| `name` | [operations.GranularityName](../../models/operations/granularityname.mdx) | ✅ | Granularity identifier | day | \ No newline at end of file diff --git a/docs/models/operations/imageurl.mdx b/docs/models/operations/imageurl.mdx index 6d19b531e..2c0f92c08 100644 --- a/docs/models/operations/imageurl.mdx +++ b/docs/models/operations/imageurl.mdx @@ -16,4 +16,4 @@ let value: ImageUrl = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/input.mdx b/docs/models/operations/input.mdx index 004865804..3f1590ba1 100644 --- a/docs/models/operations/input.mdx +++ b/docs/models/operations/input.mdx @@ -16,4 +16,4 @@ let value: Input = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `content` | *operations.Content*[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *operations.Content*[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/invokeinternglobals.mdx b/docs/models/operations/invokeinternglobals.mdx index 7b553ff42..292a99d15 100644 --- a/docs/models/operations/invokeinternglobals.mdx +++ b/docs/models/operations/invokeinternglobals.mdx @@ -14,6 +14,6 @@ let value: InvokeInternGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/invokeinternrequest.mdx b/docs/models/operations/invokeinternrequest.mdx index fe091ea3e..3711cfc93 100644 --- a/docs/models/operations/invokeinternrequest.mdx +++ b/docs/models/operations/invokeinternrequest.mdx @@ -20,8 +20,8 @@ let value: InvokeInternRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | The intern to run. | a11e0000-0000-4000-8000-000000000005 | -| `internInvokeRequest` | [models.InternInvokeRequest](../../models/interninvokerequest.mdx) | :heavy_check_mark: | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | The intern to run. | a11e0000-0000-4000-8000-000000000005 | +| `internInvokeRequest` | [models.InternInvokeRequest](../../models/interninvokerequest.mdx) | ✅ | N/A | \{
"input": "New support ticket 48213. Case token: ct_9f2c. Investigate and reply."
} | \ No newline at end of file diff --git a/docs/models/operations/invokeinternresponse.mdx b/docs/models/operations/invokeinternresponse.mdx index d1a52c5db..54848954f 100644 --- a/docs/models/operations/invokeinternresponse.mdx +++ b/docs/models/operations/invokeinternresponse.mdx @@ -20,5 +20,5 @@ let value: InvokeInternResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `headers` | Record\ | :heavy_check_mark: | N/A | | -| `result` | [models.InternInvokeAcceptedResponse](../../models/interninvokeacceptedresponse.mdx) | :heavy_check_mark: | N/A | \{
"session_id": "b51a0e21-368b-4780-a220-14655bf28c55",
"status": "started"
} | \ No newline at end of file +| `headers` | Record\ | ✅ | N/A | | +| `result` | [models.InternInvokeAcceptedResponse](../../models/interninvokeacceptedresponse.mdx) | ✅ | N/A | \{
"session_id": "b51a0e21-368b-4780-a220-14655bf28c55",
"status": "started"
} | \ No newline at end of file diff --git a/docs/models/operations/listbatchesglobals.mdx b/docs/models/operations/listbatchesglobals.mdx index 24476bcc5..efa6d2a9f 100644 --- a/docs/models/operations/listbatchesglobals.mdx +++ b/docs/models/operations/listbatchesglobals.mdx @@ -14,6 +14,6 @@ let value: ListBatchesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listbatchesrequest.mdx b/docs/models/operations/listbatchesrequest.mdx index b9b185e0d..cff9efbec 100644 --- a/docs/models/operations/listbatchesrequest.mdx +++ b/docs/models/operations/listbatchesrequest.mdx @@ -14,11 +14,11 @@ let value: ListBatchesRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of batches to return, from 1 through 100. | 20 | -| `after` | *string* | :heavy_minus_sign: | Batch id from the previous page's `last_id`. | batch_7a4b02 | -| `status` | [models.BatchListStatus](../../models/batchliststatus.mdx)[] | :heavy_minus_sign: | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | -| `createdAfter` | *models.BatchListTimestamp* | :heavy_minus_sign: | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | -| `createdBefore` | *models.BatchListTimestamp* | :heavy_minus_sign: | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *number* | ➖ | Maximum number of batches to return, from 1 through 100. | 20 | +| `after` | *string* | ➖ | Batch id from the previous page's `last_id`. | batch_7a4b02 | +| `status` | [models.BatchListStatus](../../models/batchliststatus.mdx)[] | ➖ | Repeat this parameter to include more than one status. | [
"completed",
"failed"
] | +| `createdAfter` | *models.BatchListTimestamp* | ➖ | Only include batches created strictly after this timestamp. | 2026-08-20T00:00:00Z | +| `createdBefore` | *models.BatchListTimestamp* | ➖ | Only include batches created strictly before this timestamp. | 2026-08-20T00:00:00Z | \ No newline at end of file diff --git a/docs/models/operations/listbatchesresponse.mdx b/docs/models/operations/listbatchesresponse.mdx index c858d1324..0800ff811 100644 --- a/docs/models/operations/listbatchesresponse.mdx +++ b/docs/models/operations/listbatchesresponse.mdx @@ -22,4 +22,4 @@ let value: ListBatchesResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `result` | [models.BatchListResponse](../../models/batchlistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [],
"first_id": null,
"has_more": false,
"last_id": null,
"object": "list"
} | \ No newline at end of file +| `result` | [models.BatchListResponse](../../models/batchlistresponse.mdx) | ✅ | N/A | \{
"data": [],
"first_id": null,
"has_more": false,
"last_id": null,
"object": "list"
} | \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysglobals.mdx b/docs/models/operations/listbyokkeysglobals.mdx index 21ef4bcc8..af6a5d632 100644 --- a/docs/models/operations/listbyokkeysglobals.mdx +++ b/docs/models/operations/listbyokkeysglobals.mdx @@ -14,6 +14,6 @@ let value: ListBYOKKeysGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysrequest.mdx b/docs/models/operations/listbyokkeysrequest.mdx index c3e59cd7c..e2c8a782e 100644 --- a/docs/models/operations/listbyokkeysrequest.mdx +++ b/docs/models/operations/listbyokkeysrequest.mdx @@ -14,10 +14,10 @@ let value: ListBYOKKeysRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | -| `provider` | [operations.Provider](../../models/operations/provider.mdx) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspaceId` | *string* | ➖ | Optional workspace ID to filter by. When omitted, resolves to the account’s default workspace; if that default has been deleted, the request returns a 400 and you must pass `workspace_id` explicitly. | 550e8400-e29b-41d4-a716-446655440000 | +| `provider` | [operations.Provider](../../models/operations/provider.mdx) | ➖ | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysresponse.mdx b/docs/models/operations/listbyokkeysresponse.mdx index e080c0fc5..7e5310357 100644 --- a/docs/models/operations/listbyokkeysresponse.mdx +++ b/docs/models/operations/listbyokkeysresponse.mdx @@ -37,4 +37,4 @@ let value: ListBYOKKeysResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [models.ListBYOKKeysResponse](../../models/listbyokkeysresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListBYOKKeysResponse](../../models/listbyokkeysresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listcontainerfilesglobals.mdx b/docs/models/operations/listcontainerfilesglobals.mdx index 75cb0d0f4..56541561d 100644 --- a/docs/models/operations/listcontainerfilesglobals.mdx +++ b/docs/models/operations/listcontainerfilesglobals.mdx @@ -14,6 +14,6 @@ let value: ListContainerFilesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listcontainerfilesrequest.mdx b/docs/models/operations/listcontainerfilesrequest.mdx index ff1474a28..74a3103d3 100644 --- a/docs/models/operations/listcontainerfilesrequest.mdx +++ b/docs/models/operations/listcontainerfilesrequest.mdx @@ -16,9 +16,9 @@ let value: ListContainerFilesRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `containerId` | *string* | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | -| `after` | *string* | :heavy_minus_sign: | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `containerId` | *string* | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `limit` | *number* | ➖ | Maximum number of files to return (1-1000). Defaults to 100 when absent. | 100 | +| `after` | *string* | ➖ | Forward cursor: the previous page’s `last_id` (or any container file id); listing resumes strictly after that path. A `last_id` from a page that stopped at the scan bound may name a directory-marker path (trailing `/`) that was never listed as a file; such cursors are accepted. | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/listdata.mdx b/docs/models/operations/listdata.mdx index 217f96085..2c54b3eb7 100644 --- a/docs/models/operations/listdata.mdx +++ b/docs/models/operations/listdata.mdx @@ -37,26 +37,26 @@ let value: ListData = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `externalUser` | *string* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `lastUsedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byokUsage` | *number* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byokUsageDaily` | *number* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byokUsageMonthly` | *number* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byokUsageWeekly` | *number* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creatorUserId` | *string* | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `disabled` | *boolean* | ✅ | Whether the API key is disabled | false | +| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `externalUser` | *string* | ✅ | Partner's end-user identifier used for attribution. | null | +| `hash` | *string* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `includeByokInLimit` | *boolean* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `label` | *string* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `lastUsedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `limit` | *number* | ✅ | Spending limit for the API key in USD | 100 | +| `limitRemaining` | *number* | ✅ | Remaining spending limit in USD | 74.5 | +| `limitReset` | *string* | ✅ | Type of limit reset for the API key | monthly | +| `name` | *string* | ✅ | Name of the API key | My Production Key | +| `updatedAt` | *string* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *number* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usageDaily` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usageMonthly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usageWeekly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspaceId` | *string* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/listembeddingsmodelsglobals.mdx b/docs/models/operations/listembeddingsmodelsglobals.mdx index e68318821..7df187db9 100644 --- a/docs/models/operations/listembeddingsmodelsglobals.mdx +++ b/docs/models/operations/listembeddingsmodelsglobals.mdx @@ -14,6 +14,6 @@ let value: ListEmbeddingsModelsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listembeddingsmodelsrequest.mdx b/docs/models/operations/listembeddingsmodelsrequest.mdx index c7a78d864..92556aad5 100644 --- a/docs/models/operations/listembeddingsmodelsrequest.mdx +++ b/docs/models/operations/listembeddingsmodelsrequest.mdx @@ -14,8 +14,8 @@ let value: ListEmbeddingsModelsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | \ No newline at end of file diff --git a/docs/models/operations/listembeddingsmodelsresponse.mdx b/docs/models/operations/listembeddingsmodelsresponse.mdx index c8ad5c2ca..8a93579f0 100644 --- a/docs/models/operations/listembeddingsmodelsresponse.mdx +++ b/docs/models/operations/listembeddingsmodelsresponse.mdx @@ -59,4 +59,4 @@ let value: ListEmbeddingsModelsResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ModelsListResponse](../../models/modelslistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file +| `result` | [models.ModelsListResponse](../../models/modelslistresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/listendpointsglobals.mdx b/docs/models/operations/listendpointsglobals.mdx index 5a0f629b4..2f379812d 100644 --- a/docs/models/operations/listendpointsglobals.mdx +++ b/docs/models/operations/listendpointsglobals.mdx @@ -14,6 +14,6 @@ let value: ListEndpointsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listendpointsrequest.mdx b/docs/models/operations/listendpointsrequest.mdx index 3a3a78ac4..da425cfe4 100644 --- a/docs/models/operations/listendpointsrequest.mdx +++ b/docs/models/operations/listendpointsrequest.mdx @@ -17,8 +17,8 @@ let value: ListEndpointsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *string* | :heavy_check_mark: | The author/organization of the model | openai | -| `slug` | *string* | :heavy_check_mark: | The model slug | gpt-4 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `author` | *string* | ✅ | The author/organization of the model | openai | +| `slug` | *string* | ✅ | The model slug | gpt-4 | \ No newline at end of file diff --git a/docs/models/operations/listendpointsresponse.mdx b/docs/models/operations/listendpointsresponse.mdx index a6d7bbc71..67769f8c3 100644 --- a/docs/models/operations/listendpointsresponse.mdx +++ b/docs/models/operations/listendpointsresponse.mdx @@ -80,4 +80,4 @@ let value: ListEndpointsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | [models.ListEndpointsResponse](../../models/listendpointsresponse.mdx) | :heavy_check_mark: | List of available endpoints for a model | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"created": 1692901234,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"endpoints": [
\{
"context_length": 8192,
"latency_last_30m": \{
"p50": 0.25,
"p75": 0.35,
"p90": 0.48,
"p99": 0.85
},
"max_completion_tokens": 4096,
"max_prompt_tokens": 8192,
"model_id": "openai/gpt-4",
"model_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"provider_name": "OpenAI",
"quantization": "fp16",
"status": 0,
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supports_implicit_caching": true,
"tag": "openai",
"throughput_last_30m": \{
"p50": 45.2,
"p75": 38.5,
"p90": 28.3,
"p99": 15.1
},
"uptime_last_1d": 99.8,
"uptime_last_30m": 99.5,
"uptime_last_5m": 100
}
],
"id": "openai/gpt-4",
"name": "GPT-4"
} | \ No newline at end of file +| `data` | [models.ListEndpointsResponse](../../models/listendpointsresponse.mdx) | ✅ | List of available endpoints for a model | \{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"created": 1692901234,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"endpoints": [
\{
"context_length": 8192,
"latency_last_30m": \{
"p50": 0.25,
"p75": 0.35,
"p90": 0.48,
"p99": 0.85
},
"max_completion_tokens": 4096,
"max_prompt_tokens": 8192,
"model_id": "openai/gpt-4",
"model_name": "GPT-4",
"name": "OpenAI: GPT-4",
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"provider_name": "OpenAI",
"quantization": "fp16",
"status": 0,
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supports_implicit_caching": true,
"tag": "openai",
"throughput_last_30m": \{
"p50": 45.2,
"p75": 38.5,
"p90": 28.3,
"p99": 15.1
},
"uptime_last_1d": 99.8,
"uptime_last_30m": 99.5,
"uptime_last_5m": 100
}
],
"id": "openai/gpt-4",
"name": "GPT-4"
} | \ No newline at end of file diff --git a/docs/models/operations/listendpointszdrglobals.mdx b/docs/models/operations/listendpointszdrglobals.mdx index 516c80013..d34d6da22 100644 --- a/docs/models/operations/listendpointszdrglobals.mdx +++ b/docs/models/operations/listendpointszdrglobals.mdx @@ -14,6 +14,6 @@ let value: ListEndpointsZdrGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listendpointszdrrequest.mdx b/docs/models/operations/listendpointszdrrequest.mdx index a39d224e4..fe22548b4 100644 --- a/docs/models/operations/listendpointszdrrequest.mdx +++ b/docs/models/operations/listendpointszdrrequest.mdx @@ -14,6 +14,6 @@ let value: ListEndpointsZdrRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listendpointszdrresponse.mdx b/docs/models/operations/listendpointszdrresponse.mdx index 97c258426..738754d48 100644 --- a/docs/models/operations/listendpointszdrresponse.mdx +++ b/docs/models/operations/listendpointszdrresponse.mdx @@ -62,4 +62,4 @@ let value: ListEndpointsZdrResponse = { | Field | Type | Required | Description | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `data` | [models.PublicEndpoint](../../models/publicendpoint.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.PublicEndpoint](../../models/publicendpoint.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listendusersglobals.mdx b/docs/models/operations/listendusersglobals.mdx index 0a953dc8f..b2c1eb9cc 100644 --- a/docs/models/operations/listendusersglobals.mdx +++ b/docs/models/operations/listendusersglobals.mdx @@ -14,6 +14,6 @@ let value: ListEndUsersGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listendusersrequest.mdx b/docs/models/operations/listendusersrequest.mdx index ad676c0b7..af3f4f4d2 100644 --- a/docs/models/operations/listendusersrequest.mdx +++ b/docs/models/operations/listendusersrequest.mdx @@ -14,10 +14,10 @@ let value: ListEndUsersRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `user` | *string* | :heavy_minus_sign: | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | -| `includeInactive` | *boolean* | :heavy_minus_sign: | Include deactivated registrations. | false | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | +| `user` | *string* | ➖ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | +| `includeInactive` | *boolean* | ➖ | Include deactivated registrations. | false | \ No newline at end of file diff --git a/docs/models/operations/listendusersresponse.mdx b/docs/models/operations/listendusersresponse.mdx index d8c822268..ef15aa4de 100644 --- a/docs/models/operations/listendusersresponse.mdx +++ b/docs/models/operations/listendusersresponse.mdx @@ -26,4 +26,4 @@ let value: ListEndUsersResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListEndUsersResponse](../../models/listendusersresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListEndUsersResponse](../../models/listendusersresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2026-09-16T12:00:00Z",
"is_active": true,
"updated_at": "2026-09-16T12:00:00Z",
"user": "employee_123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listfilesglobals.mdx b/docs/models/operations/listfilesglobals.mdx index d8acd063b..bb3c3cd74 100644 --- a/docs/models/operations/listfilesglobals.mdx +++ b/docs/models/operations/listfilesglobals.mdx @@ -14,6 +14,6 @@ let value: ListFilesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listfilesrequest.mdx b/docs/models/operations/listfilesrequest.mdx index aff45b94b..c45550ba4 100644 --- a/docs/models/operations/listfilesrequest.mdx +++ b/docs/models/operations/listfilesrequest.mdx @@ -14,14 +14,14 @@ let value: ListFilesRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of files to return (1–1000). | 100 | -| `cursor` | *string* | :heavy_minus_sign: | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | -| `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `after` | *string* | :heavy_minus_sign: | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `afterId` | *string* | :heavy_minus_sign: | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `beforeId` | *string* | :heavy_minus_sign: | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | -| `order` | [operations.Order](../../models/operations/order.mdx) | :heavy_minus_sign: | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *number* | ➖ | Maximum number of files to return (1–1000). | 100 | +| `cursor` | *string* | ➖ | Opaque pagination cursor from a previous response. | eyJjdXJzb3IiOiJvcl9maWxlXzAxMUNOaGE4aUNKY1Uxd1hOUjZxNFY4dyJ9 | +| `workspaceId` | *string* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `after` | *string* | ➖ | OpenAI-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `afterId` | *string* | ➖ | Anthropic-style forward cursor: the id to list after. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `beforeId` | *string* | ➖ | Anthropic-style reverse cursor. Not supported by OpenRouter storage. | or_file_011CNha8iCJcU1wXNR6q4V8w | +| `order` | [operations.Order](../../models/operations/order.mdx) | ➖ | Sort direction. Only `asc` is supported by OpenRouter storage. | asc | \ No newline at end of file diff --git a/docs/models/operations/listfilesresponse.mdx b/docs/models/operations/listfilesresponse.mdx index acc30877c..97a70e79b 100644 --- a/docs/models/operations/listfilesresponse.mdx +++ b/docs/models/operations/listfilesresponse.mdx @@ -23,4 +23,4 @@ let value: ListFilesResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `result` | *models.FileListResponse* | :heavy_check_mark: | N/A | \{
"_shape": "openrouter",
"cursor": null,
"data": [],
"first_id": null,
"has_more": false,
"last_id": null
} | \ No newline at end of file +| `result` | *models.FileListResponse* | ✅ | N/A | \{
"_shape": "openrouter",
"cursor": null,
"data": [],
"first_id": null,
"has_more": false,
"last_id": null
} | \ No newline at end of file diff --git a/docs/models/operations/listgenerationcontentglobals.mdx b/docs/models/operations/listgenerationcontentglobals.mdx index 51495a59d..89dcce3e8 100644 --- a/docs/models/operations/listgenerationcontentglobals.mdx +++ b/docs/models/operations/listgenerationcontentglobals.mdx @@ -14,6 +14,6 @@ let value: ListGenerationContentGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listgenerationcontentrequest.mdx b/docs/models/operations/listgenerationcontentrequest.mdx index 5ffcc3f39..b29897243 100644 --- a/docs/models/operations/listgenerationcontentrequest.mdx +++ b/docs/models/operations/listgenerationcontentrequest.mdx @@ -16,7 +16,7 @@ let value: ListGenerationContentRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The generation ID | gen-1234567890 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The generation ID | gen-1234567890 | \ No newline at end of file diff --git a/docs/models/operations/listglobals.mdx b/docs/models/operations/listglobals.mdx index 9b8696be6..3c1260419 100644 --- a/docs/models/operations/listglobals.mdx +++ b/docs/models/operations/listglobals.mdx @@ -14,6 +14,6 @@ let value: ListGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listguardrailkeyassignmentsglobals.mdx b/docs/models/operations/listguardrailkeyassignmentsglobals.mdx index 9c32d0720..4457a0986 100644 --- a/docs/models/operations/listguardrailkeyassignmentsglobals.mdx +++ b/docs/models/operations/listguardrailkeyassignmentsglobals.mdx @@ -14,6 +14,6 @@ let value: ListGuardrailKeyAssignmentsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listguardrailkeyassignmentsrequest.mdx b/docs/models/operations/listguardrailkeyassignmentsrequest.mdx index 0eb895a22..18fe4368e 100644 --- a/docs/models/operations/listguardrailkeyassignmentsrequest.mdx +++ b/docs/models/operations/listguardrailkeyassignmentsrequest.mdx @@ -16,9 +16,9 @@ let value: ListGuardrailKeyAssignmentsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx index 328ca111f..c377fe2fe 100644 --- a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx @@ -30,4 +30,4 @@ let value: ListGuardrailKeyAssignmentsResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListKeyAssignmentsResponse](../../models/listkeyassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListKeyAssignmentsResponse](../../models/listkeyassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listguardrailmemberassignmentsglobals.mdx b/docs/models/operations/listguardrailmemberassignmentsglobals.mdx index bbfc2532d..f9e8c5251 100644 --- a/docs/models/operations/listguardrailmemberassignmentsglobals.mdx +++ b/docs/models/operations/listguardrailmemberassignmentsglobals.mdx @@ -14,6 +14,6 @@ let value: ListGuardrailMemberAssignmentsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listguardrailmemberassignmentsrequest.mdx b/docs/models/operations/listguardrailmemberassignmentsrequest.mdx index d003d3842..086fb5098 100644 --- a/docs/models/operations/listguardrailmemberassignmentsrequest.mdx +++ b/docs/models/operations/listguardrailmemberassignmentsrequest.mdx @@ -16,9 +16,9 @@ let value: ListGuardrailMemberAssignmentsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx index 124e550dd..d5c30c26b 100644 --- a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx @@ -28,4 +28,4 @@ let value: ListGuardrailMemberAssignmentsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListMemberAssignmentsResponse](../../models/listmemberassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListMemberAssignmentsResponse](../../models/listmemberassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listguardrailsglobals.mdx b/docs/models/operations/listguardrailsglobals.mdx index 44d5bd37a..839ea1e73 100644 --- a/docs/models/operations/listguardrailsglobals.mdx +++ b/docs/models/operations/listguardrailsglobals.mdx @@ -14,6 +14,6 @@ let value: ListGuardrailsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listguardrailsrequest.mdx b/docs/models/operations/listguardrailsrequest.mdx index bea0e0488..c97cd2b62 100644 --- a/docs/models/operations/listguardrailsrequest.mdx +++ b/docs/models/operations/listguardrailsrequest.mdx @@ -14,9 +14,9 @@ let value: ListGuardrailsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspaceId` | *string* | :heavy_minus_sign: | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspaceId` | *string* | ➖ | Filter guardrails by workspace ID. By default, guardrails in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/listguardrailsresponse.mdx b/docs/models/operations/listguardrailsresponse.mdx index 38f483ff9..46c6d6b34 100644 --- a/docs/models/operations/listguardrailsresponse.mdx +++ b/docs/models/operations/listguardrailsresponse.mdx @@ -27,4 +27,4 @@ let value: ListGuardrailsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListGuardrailsResponse](../../models/listguardrailsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListGuardrailsResponse](../../models/listguardrailsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listimagemodelendpointsglobals.mdx b/docs/models/operations/listimagemodelendpointsglobals.mdx index d70299cc0..3cdd72e77 100644 --- a/docs/models/operations/listimagemodelendpointsglobals.mdx +++ b/docs/models/operations/listimagemodelendpointsglobals.mdx @@ -14,6 +14,6 @@ let value: ListImageModelEndpointsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listimagemodelendpointsrequest.mdx b/docs/models/operations/listimagemodelendpointsrequest.mdx index 8a7f0d033..60cf97550 100644 --- a/docs/models/operations/listimagemodelendpointsrequest.mdx +++ b/docs/models/operations/listimagemodelendpointsrequest.mdx @@ -17,8 +17,8 @@ let value: ListImageModelEndpointsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `author` | *string* | :heavy_check_mark: | Model author/organization | bytedance-seed | -| `slug` | *string* | :heavy_check_mark: | Model slug | seedream-4.5 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `author` | *string* | ✅ | Model author/organization | bytedance-seed | +| `slug` | *string* | ✅ | Model slug | seedream-4.5 | \ No newline at end of file diff --git a/docs/models/operations/listimagemodelsglobals.mdx b/docs/models/operations/listimagemodelsglobals.mdx index 8acd6129e..2860ca129 100644 --- a/docs/models/operations/listimagemodelsglobals.mdx +++ b/docs/models/operations/listimagemodelsglobals.mdx @@ -14,6 +14,6 @@ let value: ListImageModelsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listimagemodelsrequest.mdx b/docs/models/operations/listimagemodelsrequest.mdx index 6880d9d81..ffb33fbfd 100644 --- a/docs/models/operations/listimagemodelsrequest.mdx +++ b/docs/models/operations/listimagemodelsrequest.mdx @@ -14,6 +14,6 @@ let value: ListImageModelsRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listinterneffectivevaultsecretsglobals.mdx b/docs/models/operations/listinterneffectivevaultsecretsglobals.mdx index 3e627a5b3..21f0116e4 100644 --- a/docs/models/operations/listinterneffectivevaultsecretsglobals.mdx +++ b/docs/models/operations/listinterneffectivevaultsecretsglobals.mdx @@ -14,6 +14,6 @@ let value: ListInternEffectiveVaultSecretsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx b/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx index 8f8748a2b..f32e27d35 100644 --- a/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx +++ b/docs/models/operations/listinterneffectivevaultsecretsrequest.mdx @@ -17,9 +17,9 @@ let value: ListInternEffectiveVaultSecretsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | *number* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *number* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | *number* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *number* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/listinternsglobals.mdx b/docs/models/operations/listinternsglobals.mdx index e35bf2a8b..1836f79f7 100644 --- a/docs/models/operations/listinternsglobals.mdx +++ b/docs/models/operations/listinternsglobals.mdx @@ -14,6 +14,6 @@ let value: ListInternsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listinternsrequest.mdx b/docs/models/operations/listinternsrequest.mdx index e65454e01..360550785 100644 --- a/docs/models/operations/listinternsrequest.mdx +++ b/docs/models/operations/listinternsrequest.mdx @@ -14,10 +14,10 @@ let value: ListInternsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of interns to return, from 1 through 500. | 50 | -| `status` | [operations.Status](../../models/operations/status.mdx)[] | :heavy_minus_sign: | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | -| `startingAfter` | *string* | :heavy_minus_sign: | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | -| `workspaceId` | *string* | :heavy_minus_sign: | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *number* | ➖ | Maximum number of interns to return, from 1 through 500. | 50 | +| `status` | [operations.Status](../../models/operations/status.mdx)[] | ➖ | Comma-separated lifecycle statuses to include, at most 8. Repeats are collapsed. | [
"queued",
"running"
] | +| `startingAfter` | *string* | ➖ | The opaque `next_cursor` of the previous page. Returns the interns that come after it in the newest-first order. A malformed cursor is a 400. | MjAyNi0wOS0xNlQwODozMDowMC4wMDAwMDBafDdjOWU2Njc5LTc0MjUtNDBkZS05NDRiLWUwN2ZjMWY5MGFlNw | +| `workspaceId` | *string* | ➖ | Only return interns in this workspace. It must match the API key workspace. | 89f9f5b2-3f89-4eaf-83ca-5ceae149e8bb | \ No newline at end of file diff --git a/docs/models/operations/listinternvaultsecretsglobals.mdx b/docs/models/operations/listinternvaultsecretsglobals.mdx index 2b764af1f..94020748b 100644 --- a/docs/models/operations/listinternvaultsecretsglobals.mdx +++ b/docs/models/operations/listinternvaultsecretsglobals.mdx @@ -14,6 +14,6 @@ let value: ListInternVaultSecretsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listinternvaultsecretsrequest.mdx b/docs/models/operations/listinternvaultsecretsrequest.mdx index 6e92a7126..19a37df30 100644 --- a/docs/models/operations/listinternvaultsecretsrequest.mdx +++ b/docs/models/operations/listinternvaultsecretsrequest.mdx @@ -17,9 +17,9 @@ let value: ListInternVaultSecretsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `limit` | *number* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *number* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `limit` | *number* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *number* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/listkeyassignmentsglobals.mdx b/docs/models/operations/listkeyassignmentsglobals.mdx index 69322e8f3..2c9a3f9b8 100644 --- a/docs/models/operations/listkeyassignmentsglobals.mdx +++ b/docs/models/operations/listkeyassignmentsglobals.mdx @@ -14,6 +14,6 @@ let value: ListKeyAssignmentsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listkeyassignmentsrequest.mdx b/docs/models/operations/listkeyassignmentsrequest.mdx index 74a455072..43e288b96 100644 --- a/docs/models/operations/listkeyassignmentsrequest.mdx +++ b/docs/models/operations/listkeyassignmentsrequest.mdx @@ -14,8 +14,8 @@ let value: ListKeyAssignmentsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listkeyassignmentsresponse.mdx b/docs/models/operations/listkeyassignmentsresponse.mdx index 199a6db53..0e93039b2 100644 --- a/docs/models/operations/listkeyassignmentsresponse.mdx +++ b/docs/models/operations/listkeyassignmentsresponse.mdx @@ -30,4 +30,4 @@ let value: ListKeyAssignmentsResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListKeyAssignmentsResponse](../../models/listkeyassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListKeyAssignmentsResponse](../../models/listkeyassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"key_hash": "c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93",
"key_label": "prod-key",
"key_name": "Production Key"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listmemberassignmentsglobals.mdx b/docs/models/operations/listmemberassignmentsglobals.mdx index e7e4e32f7..a1a4275a8 100644 --- a/docs/models/operations/listmemberassignmentsglobals.mdx +++ b/docs/models/operations/listmemberassignmentsglobals.mdx @@ -14,6 +14,6 @@ let value: ListMemberAssignmentsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listmemberassignmentsrequest.mdx b/docs/models/operations/listmemberassignmentsrequest.mdx index a37509a5e..e7a7e0f1f 100644 --- a/docs/models/operations/listmemberassignmentsrequest.mdx +++ b/docs/models/operations/listmemberassignmentsrequest.mdx @@ -14,8 +14,8 @@ let value: ListMemberAssignmentsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listmemberassignmentsresponse.mdx b/docs/models/operations/listmemberassignmentsresponse.mdx index c435951eb..c7215ca20 100644 --- a/docs/models/operations/listmemberassignmentsresponse.mdx +++ b/docs/models/operations/listmemberassignmentsresponse.mdx @@ -28,4 +28,4 @@ let value: ListMemberAssignmentsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListMemberAssignmentsResponse](../../models/listmemberassignmentsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListMemberAssignmentsResponse](../../models/listmemberassignmentsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"assigned_by": "user_abc123",
"created_at": "2025-08-24T10:30:00Z",
"guardrail_id": "550e8400-e29b-41d4-a716-446655440001",
"id": "550e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_xyz789",
"user_id": "user_abc123"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listmodelscountglobals.mdx b/docs/models/operations/listmodelscountglobals.mdx index b8301f5ff..202cb7d29 100644 --- a/docs/models/operations/listmodelscountglobals.mdx +++ b/docs/models/operations/listmodelscountglobals.mdx @@ -14,6 +14,6 @@ let value: ListModelsCountGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listmodelscountrequest.mdx b/docs/models/operations/listmodelscountrequest.mdx index d29b6fbb0..5f0220924 100644 --- a/docs/models/operations/listmodelscountrequest.mdx +++ b/docs/models/operations/listmodelscountrequest.mdx @@ -14,7 +14,7 @@ let value: ListModelsCountRequest = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `outputModalities` | *string* | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `outputModalities` | *string* | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file diff --git a/docs/models/operations/listmodelsuserglobals.mdx b/docs/models/operations/listmodelsuserglobals.mdx index a02663cf9..bb86b3661 100644 --- a/docs/models/operations/listmodelsuserglobals.mdx +++ b/docs/models/operations/listmodelsuserglobals.mdx @@ -14,6 +14,6 @@ let value: ListModelsUserGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listmodelsuserrequest.mdx b/docs/models/operations/listmodelsuserrequest.mdx index 12352c8d2..c3c4270ea 100644 --- a/docs/models/operations/listmodelsuserrequest.mdx +++ b/docs/models/operations/listmodelsuserrequest.mdx @@ -14,9 +14,9 @@ let value: ListModelsUserRequest = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `outputModalities` | *string* | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | +| `outputModalities` | *string* | ➖ | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, embeddings, audio, video, rerank, decisions, speech, transcription) or "all" to include all models. Defaults to "text". | text | \ No newline at end of file diff --git a/docs/models/operations/listmodelsuserresponse.mdx b/docs/models/operations/listmodelsuserresponse.mdx index 9fb49555f..7cc8aac52 100644 --- a/docs/models/operations/listmodelsuserresponse.mdx +++ b/docs/models/operations/listmodelsuserresponse.mdx @@ -59,4 +59,4 @@ let value: ListModelsUserResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ModelsListResponse](../../models/modelslistresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file +| `result` | [models.ModelsListResponse](../../models/modelslistresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"architecture": \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
},
"canonical_slug": "openai/gpt-4",
"context_length": 8192,
"created": 1692901234,
"default_parameters": null,
"description": "GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy.",
"expiration_date": null,
"id": "openai/gpt-4",
"knowledge_cutoff": null,
"links": \{
"details": "/api/v1/models/openai/gpt-4/endpoints"
},
"name": "GPT-4",
"per_request_limits": null,
"pricing": \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
},
"supported_parameters": [
"temperature",
"top_p",
"max_tokens",
"frequency_penalty",
"presence_penalty"
],
"supported_voices": null,
"top_provider": \{
"context_length": 8192,
"is_moderated": true,
"max_completion_tokens": 4096
}
}
],
"links": \{
"next": "/api/v1/models?offset=500\u0026limit=500"
},
"total_count": 150
} | \ No newline at end of file diff --git a/docs/models/operations/listmodelsusersecurity.mdx b/docs/models/operations/listmodelsusersecurity.mdx index c9a077524..0918d2576 100644 --- a/docs/models/operations/listmodelsusersecurity.mdx +++ b/docs/models/operations/listmodelsusersecurity.mdx @@ -16,4 +16,4 @@ let value: ListModelsUserSecurity = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bearer` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listoauthjwksglobals.mdx b/docs/models/operations/listoauthjwksglobals.mdx index 7c8ec0a92..6d1c686f9 100644 --- a/docs/models/operations/listoauthjwksglobals.mdx +++ b/docs/models/operations/listoauthjwksglobals.mdx @@ -14,6 +14,6 @@ let value: ListOauthJwksGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listoauthjwksrequest.mdx b/docs/models/operations/listoauthjwksrequest.mdx index b2794739c..886f8c64a 100644 --- a/docs/models/operations/listoauthjwksrequest.mdx +++ b/docs/models/operations/listoauthjwksrequest.mdx @@ -14,6 +14,6 @@ let value: ListOauthJwksRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listobservabilitydestinationsglobals.mdx b/docs/models/operations/listobservabilitydestinationsglobals.mdx index 7daed84b0..2330fe96d 100644 --- a/docs/models/operations/listobservabilitydestinationsglobals.mdx +++ b/docs/models/operations/listobservabilitydestinationsglobals.mdx @@ -14,6 +14,6 @@ let value: ListObservabilityDestinationsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listobservabilitydestinationsrequest.mdx b/docs/models/operations/listobservabilitydestinationsrequest.mdx index acd9573ac..2706ada69 100644 --- a/docs/models/operations/listobservabilitydestinationsrequest.mdx +++ b/docs/models/operations/listobservabilitydestinationsrequest.mdx @@ -14,9 +14,9 @@ let value: ListObservabilityDestinationsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `workspaceId` | *string* | :heavy_minus_sign: | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | +| `workspaceId` | *string* | ➖ | Optional workspace ID to filter by. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/operations/listobservabilitydestinationsresponse.mdx b/docs/models/operations/listobservabilitydestinationsresponse.mdx index e5b82488d..27642ffdb 100644 --- a/docs/models/operations/listobservabilitydestinationsresponse.mdx +++ b/docs/models/operations/listobservabilitydestinationsresponse.mdx @@ -44,4 +44,4 @@ let value: ListObservabilityDestinationsResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListObservabilityDestinationsResponse](../../models/listobservabilitydestinationsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListObservabilityDestinationsResponse](../../models/listobservabilitydestinationsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersdata.mdx b/docs/models/operations/listorganizationmembersdata.mdx index 65815cfff..d7e72cf74 100644 --- a/docs/models/operations/listorganizationmembersdata.mdx +++ b/docs/models/operations/listorganizationmembersdata.mdx @@ -20,8 +20,8 @@ let value: ListOrganizationMembersData = { | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `email` | *string* | :heavy_check_mark: | Email address of the member | jane.doe@example.com | -| `firstName` | *string* | :heavy_check_mark: | First name of the member | Jane | -| `id` | *string* | :heavy_check_mark: | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | -| `lastName` | *string* | :heavy_check_mark: | Last name of the member | Doe | -| `role` | [operations.Role](../../models/operations/role.mdx) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file +| `email` | *string* | ✅ | Email address of the member | jane.doe@example.com | +| `firstName` | *string* | ✅ | First name of the member | Jane | +| `id` | *string* | ✅ | User ID of the organization member | user_2dHFtVWx2n56w6HkM0000000000 | +| `lastName` | *string* | ✅ | Last name of the member | Doe | +| `role` | [operations.Role](../../models/operations/role.mdx) | ✅ | Role of the member in the organization | org:member | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersglobals.mdx b/docs/models/operations/listorganizationmembersglobals.mdx index feaa88a29..e65c532c5 100644 --- a/docs/models/operations/listorganizationmembersglobals.mdx +++ b/docs/models/operations/listorganizationmembersglobals.mdx @@ -14,6 +14,6 @@ let value: ListOrganizationMembersGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersrequest.mdx b/docs/models/operations/listorganizationmembersrequest.mdx index 715d4d875..247704720 100644 --- a/docs/models/operations/listorganizationmembersrequest.mdx +++ b/docs/models/operations/listorganizationmembersrequest.mdx @@ -14,8 +14,8 @@ let value: ListOrganizationMembersRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponse.mdx b/docs/models/operations/listorganizationmembersresponse.mdx index de6e7343f..5f556c812 100644 --- a/docs/models/operations/listorganizationmembersresponse.mdx +++ b/docs/models/operations/listorganizationmembersresponse.mdx @@ -19,4 +19,4 @@ let value: ListOrganizationMembersResponse = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `result` | [operations.ListOrganizationMembersResponseBody](../../models/operations/listorganizationmembersresponsebody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `result` | [operations.ListOrganizationMembersResponseBody](../../models/operations/listorganizationmembersresponsebody.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponsebody.mdx b/docs/models/operations/listorganizationmembersresponsebody.mdx index 332b12517..e0b6c8ec3 100644 --- a/docs/models/operations/listorganizationmembersresponsebody.mdx +++ b/docs/models/operations/listorganizationmembersresponsebody.mdx @@ -19,5 +19,5 @@ let value: ListOrganizationMembersResponseBody = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `data` | [operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata.mdx)[] | :heavy_check_mark: | List of organization members | | -| `totalCount` | *number* | :heavy_check_mark: | Total number of members in the organization | 25 | \ No newline at end of file +| `data` | [operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata.mdx)[] | ✅ | List of organization members | | +| `totalCount` | *number* | ✅ | Total number of members in the organization | 25 | \ No newline at end of file diff --git a/docs/models/operations/listpresetsglobals.mdx b/docs/models/operations/listpresetsglobals.mdx index 2344261e9..221ebc023 100644 --- a/docs/models/operations/listpresetsglobals.mdx +++ b/docs/models/operations/listpresetsglobals.mdx @@ -14,6 +14,6 @@ let value: ListPresetsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listpresetsrequest.mdx b/docs/models/operations/listpresetsrequest.mdx index fe070045b..39966df00 100644 --- a/docs/models/operations/listpresetsrequest.mdx +++ b/docs/models/operations/listpresetsrequest.mdx @@ -14,8 +14,8 @@ let value: ListPresetsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listpresetsresponse.mdx b/docs/models/operations/listpresetsresponse.mdx index e75f51a5d..0fa64fd53 100644 --- a/docs/models/operations/listpresetsresponse.mdx +++ b/docs/models/operations/listpresetsresponse.mdx @@ -33,4 +33,4 @@ let value: ListPresetsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [models.ListPresetsResponse](../../models/listpresetsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListPresetsResponse](../../models/listpresetsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2026-04-20T10:00:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"description": null,
"designated_version_id": "550e8400-e29b-41d4-a716-446655440000",
"id": "650e8400-e29b-41d4-a716-446655440001",
"name": "my-preset",
"slug": "my-preset",
"status": "active",
"status_updated_at": null,
"updated_at": "2026-04-20T10:00:00Z",
"workspace_id": "750e8400-e29b-41d4-a716-446655440002"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listpresetversionsglobals.mdx b/docs/models/operations/listpresetversionsglobals.mdx index eeea2cd15..2f8df5ba3 100644 --- a/docs/models/operations/listpresetversionsglobals.mdx +++ b/docs/models/operations/listpresetversionsglobals.mdx @@ -14,6 +14,6 @@ let value: ListPresetVersionsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listpresetversionsrequest.mdx b/docs/models/operations/listpresetversionsrequest.mdx index 8524c4d7c..2c27cb09e 100644 --- a/docs/models/operations/listpresetversionsrequest.mdx +++ b/docs/models/operations/listpresetversionsrequest.mdx @@ -16,9 +16,9 @@ let value: ListPresetVersionsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `slug` | *string* | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `slug` | *string* | ✅ | URL-safe slug identifying the preset. | my-preset | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listpresetversionsresponse.mdx b/docs/models/operations/listpresetversionsresponse.mdx index 6eba04305..6a3ab1fc0 100644 --- a/docs/models/operations/listpresetversionsresponse.mdx +++ b/docs/models/operations/listpresetversionsresponse.mdx @@ -33,4 +33,4 @@ let value: ListPresetVersionsResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `result` | [models.ListPresetVersionsResponse](../../models/listpresetversionsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListPresetVersionsResponse](../../models/listpresetversionsresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listprivateendpointsglobals.mdx b/docs/models/operations/listprivateendpointsglobals.mdx index c38091d47..7143228a1 100644 --- a/docs/models/operations/listprivateendpointsglobals.mdx +++ b/docs/models/operations/listprivateendpointsglobals.mdx @@ -14,6 +14,6 @@ let value: ListPrivateEndpointsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listprivateendpointsrequest.mdx b/docs/models/operations/listprivateendpointsrequest.mdx index f6386ba86..eb1c7ef9e 100644 --- a/docs/models/operations/listprivateendpointsrequest.mdx +++ b/docs/models/operations/listprivateendpointsrequest.mdx @@ -14,6 +14,6 @@ let value: ListPrivateEndpointsRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listprovidersdata.mdx b/docs/models/operations/listprovidersdata.mdx index 32ef99d46..281e483ce 100644 --- a/docs/models/operations/listprovidersdata.mdx +++ b/docs/models/operations/listprovidersdata.mdx @@ -18,10 +18,10 @@ let value: ListProvidersData = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `datacenters` | [operations.Datacenter](../../models/operations/datacenter.mdx)[] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `headquarters` | [operations.Headquarters](../../models/operations/headquarters.mdx) | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | -| `name` | *string* | :heavy_check_mark: | Display name of the provider | OpenAI | -| `privacyPolicyUrl` | *string* | :heavy_check_mark: | URL to the provider's privacy policy | https://openai.com/privacy | -| `slug` | *string* | :heavy_check_mark: | URL-friendly identifier for the provider | openai | -| `statusPageUrl` | *string* | :heavy_minus_sign: | URL to the provider's status page | https://status.openai.com | -| `termsOfServiceUrl` | *string* | :heavy_minus_sign: | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file +| `datacenters` | [operations.Datacenter](../../models/operations/datacenter.mdx)[] | ➖ | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | +| `headquarters` | [operations.Headquarters](../../models/operations/headquarters.mdx) | ➖ | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | +| `name` | *string* | ✅ | Display name of the provider | OpenAI | +| `privacyPolicyUrl` | *string* | ✅ | URL to the provider's privacy policy | https://openai.com/privacy | +| `slug` | *string* | ✅ | URL-friendly identifier for the provider | openai | +| `statusPageUrl` | *string* | ➖ | URL to the provider's status page | https://status.openai.com | +| `termsOfServiceUrl` | *string* | ➖ | URL to the provider's terms of service | https://openai.com/terms | \ No newline at end of file diff --git a/docs/models/operations/listprovidersglobals.mdx b/docs/models/operations/listprovidersglobals.mdx index bb117d7ca..c3f89ce01 100644 --- a/docs/models/operations/listprovidersglobals.mdx +++ b/docs/models/operations/listprovidersglobals.mdx @@ -14,6 +14,6 @@ let value: ListProvidersGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listprovidersrequest.mdx b/docs/models/operations/listprovidersrequest.mdx index d6bee135f..36e7fc625 100644 --- a/docs/models/operations/listprovidersrequest.mdx +++ b/docs/models/operations/listprovidersrequest.mdx @@ -14,6 +14,6 @@ let value: ListProvidersRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listprovidersresponse.mdx b/docs/models/operations/listprovidersresponse.mdx index 4cdfd035f..4a7667d8b 100644 --- a/docs/models/operations/listprovidersresponse.mdx +++ b/docs/models/operations/listprovidersresponse.mdx @@ -24,4 +24,4 @@ let value: ListProvidersResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `data` | [operations.ListProvidersData](../../models/operations/listprovidersdata.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [operations.ListProvidersData](../../models/operations/listprovidersdata.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listrequest.mdx b/docs/models/operations/listrequest.mdx index 01b73c1f6..6083fd15b 100644 --- a/docs/models/operations/listrequest.mdx +++ b/docs/models/operations/listrequest.mdx @@ -14,9 +14,9 @@ let value: ListRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `includeDisabled` | *boolean* | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | -| `offset` | *number* | :heavy_minus_sign: | Number of API keys to skip for pagination | 0 | -| `workspaceId` | *string* | :heavy_minus_sign: | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `includeDisabled` | *boolean* | ➖ | Whether to include disabled API keys in the response | false | +| `offset` | *number* | ➖ | Number of API keys to skip for pagination | 0 | +| `workspaceId` | *string* | ➖ | Filter API keys by workspace ID. By default, keys in the default workspace are returned. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/listresponse.mdx b/docs/models/operations/listresponse.mdx index eede4b304..a7d49ceec 100644 --- a/docs/models/operations/listresponse.mdx +++ b/docs/models/operations/listresponse.mdx @@ -43,4 +43,4 @@ let value: ListResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `data` | [operations.ListData](../../models/operations/listdata.mdx)[] | :heavy_check_mark: | List of API keys | \ No newline at end of file +| `data` | [operations.ListData](../../models/operations/listdata.mdx)[] | ✅ | List of API keys | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupmappingsglobals.mdx b/docs/models/operations/listscimgroupmappingsglobals.mdx index 0acbeefa7..8abf0bd64 100644 --- a/docs/models/operations/listscimgroupmappingsglobals.mdx +++ b/docs/models/operations/listscimgroupmappingsglobals.mdx @@ -14,6 +14,6 @@ let value: ListScimGroupMappingsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listscimgroupmappingsrequest.mdx b/docs/models/operations/listscimgroupmappingsrequest.mdx index 4ba06ce8a..5a7bf14c3 100644 --- a/docs/models/operations/listscimgroupmappingsrequest.mdx +++ b/docs/models/operations/listscimgroupmappingsrequest.mdx @@ -14,8 +14,8 @@ let value: ListScimGroupMappingsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupmappingsresponse.mdx b/docs/models/operations/listscimgroupmappingsresponse.mdx index 3a13488f7..4130eff11 100644 --- a/docs/models/operations/listscimgroupmappingsresponse.mdx +++ b/docs/models/operations/listscimgroupmappingsresponse.mdx @@ -29,4 +29,4 @@ let value: ListScimGroupMappingsResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `result` | [models.ListScimGroupMappingsResponse](../../models/listscimgroupmappingsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `result` | [models.ListScimGroupMappingsResponse](../../models/listscimgroupmappingsresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupsglobals.mdx b/docs/models/operations/listscimgroupsglobals.mdx index b37da4046..17ca3bdc1 100644 --- a/docs/models/operations/listscimgroupsglobals.mdx +++ b/docs/models/operations/listscimgroupsglobals.mdx @@ -14,6 +14,6 @@ let value: ListScimGroupsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listscimgroupsrequest.mdx b/docs/models/operations/listscimgroupsrequest.mdx index 81e5c45f4..03e3cfae6 100644 --- a/docs/models/operations/listscimgroupsrequest.mdx +++ b/docs/models/operations/listscimgroupsrequest.mdx @@ -14,10 +14,10 @@ let value: ListScimGroupsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `displayName` | *string* | :heavy_minus_sign: | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | -| `externalId` | *string* | :heavy_minus_sign: | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | +| `displayName` | *string* | ➖ | Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match. | Engineering | +| `externalId` | *string* | ➖ | Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 | \ No newline at end of file diff --git a/docs/models/operations/listscimgroupsresponse.mdx b/docs/models/operations/listscimgroupsresponse.mdx index 7bd81456b..8a5347fbd 100644 --- a/docs/models/operations/listscimgroupsresponse.mdx +++ b/docs/models/operations/listscimgroupsresponse.mdx @@ -28,4 +28,4 @@ let value: ListScimGroupsResponse = { | Field | Type | Required | Description | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `result` | [models.ListScimGroupsResponse](../../models/listscimgroupsresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `result` | [models.ListScimGroupsResponse](../../models/listscimgroupsresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listtoolsglobals.mdx b/docs/models/operations/listtoolsglobals.mdx index 47136bbd4..4e12d844e 100644 --- a/docs/models/operations/listtoolsglobals.mdx +++ b/docs/models/operations/listtoolsglobals.mdx @@ -14,6 +14,6 @@ let value: ListToolsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listtoolsrequest.mdx b/docs/models/operations/listtoolsrequest.mdx index a4b7ee9ed..5f2ea1b55 100644 --- a/docs/models/operations/listtoolsrequest.mdx +++ b/docs/models/operations/listtoolsrequest.mdx @@ -14,9 +14,9 @@ let value: ListToolsRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | -| `apiFormat` | [operations.ApiFormat](../../models/operations/apiformat.mdx) | :heavy_minus_sign: | Only tools usable on this API format | responses | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100). When both offset and limit are omitted, the full list is returned | 50 | +| `apiFormat` | [operations.ApiFormat](../../models/operations/apiformat.mdx) | ➖ | Only tools usable on this API format | responses | \ No newline at end of file diff --git a/docs/models/operations/listtoolssecurity.mdx b/docs/models/operations/listtoolssecurity.mdx index 74604fb62..62a866f2e 100644 --- a/docs/models/operations/listtoolssecurity.mdx +++ b/docs/models/operations/listtoolssecurity.mdx @@ -16,4 +16,4 @@ let value: ListToolsSecurity = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bearer` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bearer` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/listvaultsecretsglobals.mdx b/docs/models/operations/listvaultsecretsglobals.mdx index acb2c68b8..e131f3f14 100644 --- a/docs/models/operations/listvaultsecretsglobals.mdx +++ b/docs/models/operations/listvaultsecretsglobals.mdx @@ -14,6 +14,6 @@ let value: ListVaultSecretsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listvaultsecretsrequest.mdx b/docs/models/operations/listvaultsecretsrequest.mdx index bb192f491..a934f6f80 100644 --- a/docs/models/operations/listvaultsecretsrequest.mdx +++ b/docs/models/operations/listvaultsecretsrequest.mdx @@ -16,8 +16,8 @@ let value: ListVaultSecretsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `limit` | *number* | :heavy_minus_sign: | Page size, 1 to 100. Defaults to 100. | 50 | -| `offset` | *number* | :heavy_minus_sign: | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `limit` | *number* | ➖ | Page size, 1 to 100. Defaults to 100. | 50 | +| `offset` | *number* | ➖ | Number of secrets to skip, 0 to 10000. Defaults to 0. | 0 | \ No newline at end of file diff --git a/docs/models/operations/listvideoscontentglobals.mdx b/docs/models/operations/listvideoscontentglobals.mdx index 2e5eb67c3..a1872bf7f 100644 --- a/docs/models/operations/listvideoscontentglobals.mdx +++ b/docs/models/operations/listvideoscontentglobals.mdx @@ -14,6 +14,6 @@ let value: ListVideosContentGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listvideoscontentrequest.mdx b/docs/models/operations/listvideoscontentrequest.mdx index d7528a47c..f75fffcb6 100644 --- a/docs/models/operations/listvideoscontentrequest.mdx +++ b/docs/models/operations/listvideoscontentrequest.mdx @@ -16,8 +16,8 @@ let value: ListVideosContentRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `jobId` | *string* | :heavy_check_mark: | N/A | job-abc123 | -| `index` | *number* | :heavy_minus_sign: | N/A | 0 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `jobId` | *string* | ✅ | N/A | job-abc123 | +| `index` | *number* | ➖ | N/A | 0 | \ No newline at end of file diff --git a/docs/models/operations/listvideosmodelsglobals.mdx b/docs/models/operations/listvideosmodelsglobals.mdx index 8849cfffe..eaf397103 100644 --- a/docs/models/operations/listvideosmodelsglobals.mdx +++ b/docs/models/operations/listvideosmodelsglobals.mdx @@ -14,6 +14,6 @@ let value: ListVideosModelsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listvideosmodelsrequest.mdx b/docs/models/operations/listvideosmodelsrequest.mdx index 810d25a54..c92a89123 100644 --- a/docs/models/operations/listvideosmodelsrequest.mdx +++ b/docs/models/operations/listvideosmodelsrequest.mdx @@ -14,6 +14,6 @@ let value: ListVideosModelsRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listworkspacebudgetsglobals.mdx b/docs/models/operations/listworkspacebudgetsglobals.mdx index 4347d4019..d6fa0d387 100644 --- a/docs/models/operations/listworkspacebudgetsglobals.mdx +++ b/docs/models/operations/listworkspacebudgetsglobals.mdx @@ -14,6 +14,6 @@ let value: ListWorkspaceBudgetsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listworkspacebudgetsrequest.mdx b/docs/models/operations/listworkspacebudgetsrequest.mdx index 63bb93903..2d90fa2c1 100644 --- a/docs/models/operations/listworkspacebudgetsrequest.mdx +++ b/docs/models/operations/listworkspacebudgetsrequest.mdx @@ -16,7 +16,7 @@ let value: ListWorkspaceBudgetsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspaceRef` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspaceRef` | *string* | ✅ | The workspace ID (UUID) or slug | production | \ No newline at end of file diff --git a/docs/models/operations/listworkspacemembersglobals.mdx b/docs/models/operations/listworkspacemembersglobals.mdx index c4bd560a5..b2ef4ca85 100644 --- a/docs/models/operations/listworkspacemembersglobals.mdx +++ b/docs/models/operations/listworkspacemembersglobals.mdx @@ -14,6 +14,6 @@ let value: ListWorkspaceMembersGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listworkspacemembersrequest.mdx b/docs/models/operations/listworkspacemembersrequest.mdx index 2cefaacfe..7738f69fc 100644 --- a/docs/models/operations/listworkspacemembersrequest.mdx +++ b/docs/models/operations/listworkspacemembersrequest.mdx @@ -16,9 +16,9 @@ let value: ListWorkspaceMembersRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The workspace ID (UUID) or slug | production | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listworkspacemembersresponse.mdx b/docs/models/operations/listworkspacemembersresponse.mdx index f847bcd83..08926703d 100644 --- a/docs/models/operations/listworkspacemembersresponse.mdx +++ b/docs/models/operations/listworkspacemembersresponse.mdx @@ -27,4 +27,4 @@ let value: ListWorkspaceMembersResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListWorkspaceMembersResponse](../../models/listworkspacemembersresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"id": "660e8400-e29b-41d4-a716-446655440000",
"role": "member",
"user_id": "user_abc123",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListWorkspaceMembersResponse](../../models/listworkspacemembersresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"id": "660e8400-e29b-41d4-a716-446655440000",
"role": "member",
"user_id": "user_abc123",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/listworkspacesglobals.mdx b/docs/models/operations/listworkspacesglobals.mdx index 4e87a10f2..2b6a5979d 100644 --- a/docs/models/operations/listworkspacesglobals.mdx +++ b/docs/models/operations/listworkspacesglobals.mdx @@ -14,6 +14,6 @@ let value: ListWorkspacesGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/listworkspacesrequest.mdx b/docs/models/operations/listworkspacesrequest.mdx index e3562ea4d..ed350bff5 100644 --- a/docs/models/operations/listworkspacesrequest.mdx +++ b/docs/models/operations/listworkspacesrequest.mdx @@ -14,8 +14,8 @@ let value: ListWorkspacesRequest = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `offset` | *number* | :heavy_minus_sign: | Number of records to skip for pagination | 0 | -| `limit` | *number* | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `offset` | *number* | ➖ | Number of records to skip for pagination | 0 | +| `limit` | *number* | ➖ | Maximum number of records to return (max 100) | 50 | \ No newline at end of file diff --git a/docs/models/operations/listworkspacesresponse.mdx b/docs/models/operations/listworkspacesresponse.mdx index 24fba1934..bc6e9b33b 100644 --- a/docs/models/operations/listworkspacesresponse.mdx +++ b/docs/models/operations/listworkspacesresponse.mdx @@ -38,4 +38,4 @@ let value: ListWorkspacesResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `result` | [models.ListWorkspacesResponse](../../models/listworkspacesresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
}
],
"total_count": 1
} | \ No newline at end of file +| `result` | [models.ListWorkspacesResponse](../../models/listworkspacesresponse.mdx) | ✅ | N/A | \{
"data": [
\{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
}
],
"total_count": 1
} | \ No newline at end of file diff --git a/docs/models/operations/metadata.mdx b/docs/models/operations/metadata.mdx index 534353cc5..d4625a561 100644 --- a/docs/models/operations/metadata.mdx +++ b/docs/models/operations/metadata.mdx @@ -18,6 +18,6 @@ let value: Metadata = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `queryTimeMs` | *number* | :heavy_check_mark: | N/A | -| `rowCount` | *number* | :heavy_check_mark: | N/A | -| `truncated` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| `queryTimeMs` | *number* | ✅ | N/A | +| `rowCount` | *number* | ✅ | N/A | +| `truncated` | *boolean* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/metric.mdx b/docs/models/operations/metric.mdx index baf32b1b8..938778d23 100644 --- a/docs/models/operations/metric.mdx +++ b/docs/models/operations/metric.mdx @@ -19,7 +19,7 @@ let value: Metric = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `displayFormat` | [operations.DisplayFormat](../../models/operations/displayformat.mdx) | :heavy_check_mark: | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | -| `displayLabel` | *string* | :heavy_check_mark: | Human-readable label | Request Count | -| `isRate` | *boolean* | :heavy_check_mark: | Whether this metric is a rate/ratio (averaged, not summed) | | -| `name` | *string* | :heavy_check_mark: | Metric identifier used in query requests | request_count | \ No newline at end of file +| `displayFormat` | [operations.DisplayFormat](../../models/operations/displayformat.mdx) | ✅ | How this metric value should be formatted for display (e.g. percent → multiply by 100 and append %, currency → prefix with $) | number | +| `displayLabel` | *string* | ✅ | Human-readable label | Request Count | +| `isRate` | *boolean* | ✅ | Whether this metric is a rate/ratio (averaged, not summed) | | +| `name` | *string* | ✅ | Metric identifier used in query requests | request_count | \ No newline at end of file diff --git a/docs/models/operations/operator.mdx b/docs/models/operations/operator.mdx index 647d5dba1..b9a3231be 100644 --- a/docs/models/operations/operator.mdx +++ b/docs/models/operations/operator.mdx @@ -17,5 +17,5 @@ let value: Operator = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `name` | [operations.OperatorName](../../models/operations/operatorname.mdx) | :heavy_check_mark: | Operator identifier used in filter definitions | eq | -| `valueType` | [operations.ValueType](../../models/operations/valuetype.mdx) | :heavy_check_mark: | Whether the operator expects a single value or an array | | \ No newline at end of file +| `name` | [operations.OperatorName](../../models/operations/operatorname.mdx) | ✅ | Operator identifier used in filter definitions | eq | +| `valueType` | [operations.ValueType](../../models/operations/valuetype.mdx) | ✅ | Whether the operator expects a single value or an array | | \ No newline at end of file diff --git a/docs/models/operations/orderby.mdx b/docs/models/operations/orderby.mdx index c0a5b8289..a3a540005 100644 --- a/docs/models/operations/orderby.mdx +++ b/docs/models/operations/orderby.mdx @@ -17,5 +17,5 @@ let value: OrderBy = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `direction` | [operations.Direction](../../models/operations/direction.mdx) | :heavy_check_mark: | N/A | | -| `field` | *string* | :heavy_check_mark: | Field to order by: a metric included in `metrics` (or "request_count", which may be ordered by without being requested), a requested dimension, or "date". | request_count | \ No newline at end of file +| `direction` | [operations.Direction](../../models/operations/direction.mdx) | ✅ | N/A | | +| `field` | *string* | ✅ | Field to order by: a metric included in `metrics` (or "request_count", which may be ordered by without being requested), a requested dimension, or "date". | request_count | \ No newline at end of file diff --git a/docs/models/operations/promotecontainerfileglobals.mdx b/docs/models/operations/promotecontainerfileglobals.mdx index ccbc47b33..f8fc0e943 100644 --- a/docs/models/operations/promotecontainerfileglobals.mdx +++ b/docs/models/operations/promotecontainerfileglobals.mdx @@ -14,6 +14,6 @@ let value: PromoteContainerFileGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/promotecontainerfilerequest.mdx b/docs/models/operations/promotecontainerfilerequest.mdx index 450f721de..c34e3c928 100644 --- a/docs/models/operations/promotecontainerfilerequest.mdx +++ b/docs/models/operations/promotecontainerfilerequest.mdx @@ -17,8 +17,8 @@ let value: PromoteContainerFileRequest = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `containerId` | *string* | :heavy_check_mark: | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | -| `fileId` | *string* | :heavy_check_mark: | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `containerId` | *string* | ✅ | The canonical container id, exactly as returned in a bash/shell tool result — a restarted session has its own `-r`-suffixed id. A session-derived id is always `sess_` + the sanitized session key, which is not necessarily the raw session id that was sent. | sess_abc123 | +| `fileId` | *string* | ✅ | Container file id (`cfile_` + base64url of the file path). | cfile_b3V0L3JlcG9ydC5jc3Y | \ No newline at end of file diff --git a/docs/models/operations/prompttokensdetails.mdx b/docs/models/operations/prompttokensdetails.mdx index de9d96527..63ca6c223 100644 --- a/docs/models/operations/prompttokensdetails.mdx +++ b/docs/models/operations/prompttokensdetails.mdx @@ -16,8 +16,8 @@ let value: PromptTokensDetails = {}; | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `audioTokens` | *number* | :heavy_minus_sign: | Number of audio tokens in the input | | -| `fileTokens` | *number* | :heavy_minus_sign: | Number of file/document tokens in the input | | -| `imageTokens` | *number* | :heavy_minus_sign: | Number of image tokens in the input | 258 | -| `textTokens` | *number* | :heavy_minus_sign: | Number of text tokens in the input | 8 | -| `videoTokens` | *number* | :heavy_minus_sign: | Number of video tokens in the input | | \ No newline at end of file +| `audioTokens` | *number* | ➖ | Number of audio tokens in the input | | +| `fileTokens` | *number* | ➖ | Number of file/document tokens in the input | | +| `imageTokens` | *number* | ➖ | Number of image tokens in the input | 258 | +| `textTokens` | *number* | ➖ | Number of text tokens in the input | 8 | +| `videoTokens` | *number* | ➖ | Number of video tokens in the input | | \ No newline at end of file diff --git a/docs/models/operations/provisioninternglobals.mdx b/docs/models/operations/provisioninternglobals.mdx index c554ae063..0694a703e 100644 --- a/docs/models/operations/provisioninternglobals.mdx +++ b/docs/models/operations/provisioninternglobals.mdx @@ -14,6 +14,6 @@ let value: ProvisionInternGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/provisioninternrequest.mdx b/docs/models/operations/provisioninternrequest.mdx index 0a34c5386..d784d9d03 100644 --- a/docs/models/operations/provisioninternrequest.mdx +++ b/docs/models/operations/provisioninternrequest.mdx @@ -16,7 +16,7 @@ let value: ProvisionInternRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsdata2.mdx b/docs/models/operations/queryanalyticsdata2.mdx index 5df8c58fb..363918673 100644 --- a/docs/models/operations/queryanalyticsdata2.mdx +++ b/docs/models/operations/queryanalyticsdata2.mdx @@ -23,7 +23,7 @@ let value: QueryAnalyticsData2 = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cachedAt` | *number* | :heavy_minus_sign: | N/A | -| `data` | [operations.QueryAnalyticsData1](../../models/operations/queryanalyticsdata1.mdx)[] | :heavy_check_mark: | N/A | -| `metadata` | [operations.Metadata](../../models/operations/metadata.mdx) | :heavy_check_mark: | N/A | -| `warnings` | *string*[] | :heavy_minus_sign: | Warnings about filter resolution issues (e.g. unresolvable api_key_id hashes). The query still runs normally; these inform the caller that some filter values could not be resolved. | \ No newline at end of file +| `cachedAt` | *number* | ➖ | N/A | +| `data` | [operations.QueryAnalyticsData1](../../models/operations/queryanalyticsdata1.mdx)[] | ✅ | N/A | +| `metadata` | [operations.Metadata](../../models/operations/metadata.mdx) | ✅ | N/A | +| `warnings` | *string*[] | ➖ | Warnings about filter resolution issues (e.g. unresolvable api_key_id hashes). The query still runs normally; these inform the caller that some filter values could not be resolved. | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsglobals.mdx b/docs/models/operations/queryanalyticsglobals.mdx index 0a4bccbab..0f54aa781 100644 --- a/docs/models/operations/queryanalyticsglobals.mdx +++ b/docs/models/operations/queryanalyticsglobals.mdx @@ -14,6 +14,6 @@ let value: QueryAnalyticsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsrequest.mdx b/docs/models/operations/queryanalyticsrequest.mdx index 6239756b4..1240da9b4 100644 --- a/docs/models/operations/queryanalyticsrequest.mdx +++ b/docs/models/operations/queryanalyticsrequest.mdx @@ -20,7 +20,7 @@ let value: QueryAnalyticsRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `requestBody` | [operations.QueryAnalyticsRequestBody](../../models/operations/queryanalyticsrequestbody.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `requestBody` | [operations.QueryAnalyticsRequestBody](../../models/operations/queryanalyticsrequestbody.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsrequestbody.mdx b/docs/models/operations/queryanalyticsrequestbody.mdx index ee21c2578..f1536e836 100644 --- a/docs/models/operations/queryanalyticsrequestbody.mdx +++ b/docs/models/operations/queryanalyticsrequestbody.mdx @@ -18,13 +18,13 @@ let value: QueryAnalyticsRequestBody = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `classifierDimensions` | [operations.ClassifierDimensions](../../models/operations/classifierdimensions.mdx) | :heavy_minus_sign: | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | -| `classifierFilters` | [operations.ClassifierFilters](../../models/operations/classifierfilters.mdx) | :heavy_minus_sign: | Filter results to generations with specific classifier tag values. Can be combined with classifier_dimensions (must use the same classifier_id) or used independently with standard dimensions. | | -| `dimensions` | *string*[] | :heavy_minus_sign: | N/A | | -| `filters` | [operations.Filter](../../models/operations/filter.mdx)[] | :heavy_minus_sign: | N/A | | -| `granularity` | *string* | :heavy_minus_sign: | Time granularity | day | -| `groupLimit` | *number* | :heavy_minus_sign: | Maximum rows per distinct combination of dimensions. When omitted on time-series queries (granularity + dimensions), auto-computed to avoid truncating time windows. Explicit values override the default and may truncate time buckets if set lower than the number of buckets in the range. Ignored when no dimensions are specified. | 100 | -| `limit` | *number* | :heavy_minus_sign: | Maximum total rows returned. Defaults to 1000. On time-series queries with dimensions and no explicit group_limit, the server may raise this to accommodate the expected number of unique time-bucket/dimension combinations. | | -| `metrics` | *string*[] | :heavy_check_mark: | N/A | | -| `orderBy` | [operations.OrderBy](../../models/operations/orderby.mdx) | :heavy_minus_sign: | N/A | | -| `timeRange` | [operations.TimeRange](../../models/operations/timerange.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `classifierDimensions` | [operations.ClassifierDimensions](../../models/operations/classifierdimensions.mdx) | ➖ | Group results by custom classifier tags, breaking down metrics by the specified dimension values. Requires an active classifier on the workspace. | | +| `classifierFilters` | [operations.ClassifierFilters](../../models/operations/classifierfilters.mdx) | ➖ | Filter results to generations with specific classifier tag values. Can be combined with classifier_dimensions (must use the same classifier_id) or used independently with standard dimensions. | | +| `dimensions` | *string*[] | ➖ | N/A | | +| `filters` | [operations.Filter](../../models/operations/filter.mdx)[] | ➖ | N/A | | +| `granularity` | *string* | ➖ | Time granularity | day | +| `groupLimit` | *number* | ➖ | Maximum rows per distinct combination of dimensions. When omitted on time-series queries (granularity + dimensions), auto-computed to avoid truncating time windows. Explicit values override the default and may truncate time buckets if set lower than the number of buckets in the range. Ignored when no dimensions are specified. | 100 | +| `limit` | *number* | ➖ | Maximum total rows returned. Defaults to 1000. On time-series queries with dimensions and no explicit group_limit, the server may raise this to accommodate the expected number of unique time-bucket/dimension combinations. | | +| `metrics` | *string*[] | ✅ | N/A | | +| `orderBy` | [operations.OrderBy](../../models/operations/orderby.mdx) | ➖ | N/A | | +| `timeRange` | [operations.TimeRange](../../models/operations/timerange.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsresponse.mdx b/docs/models/operations/queryanalyticsresponse.mdx index 772a72ac1..94bc50dd9 100644 --- a/docs/models/operations/queryanalyticsresponse.mdx +++ b/docs/models/operations/queryanalyticsresponse.mdx @@ -27,4 +27,4 @@ let value: QueryAnalyticsResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `data` | [operations.QueryAnalyticsData2](../../models/operations/queryanalyticsdata2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [operations.QueryAnalyticsData2](../../models/operations/queryanalyticsdata2.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/ratelimit.mdx b/docs/models/operations/ratelimit.mdx index 5eaf58629..82492715a 100644 --- a/docs/models/operations/ratelimit.mdx +++ b/docs/models/operations/ratelimit.mdx @@ -4,7 +4,7 @@ title: "~~RateLimit~~" Legacy rate limit information about a key. Will always return -1. -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ## Example Usage @@ -22,6 +22,6 @@ let value: RateLimit = { | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `interval` | *string* | :heavy_check_mark: | Rate limit interval | 1h | -| `note` | *string* | :heavy_check_mark: | Note about the rate limit | This field is deprecated and safe to ignore. | -| `requests` | *number* | :heavy_check_mark: | Number of requests allowed per interval | 1000 | \ No newline at end of file +| `interval` | *string* | ✅ | Rate limit interval | 1h | +| `note` | *string* | ✅ | Note about the rate limit | This field is deprecated and safe to ignore. | +| `requests` | *number* | ✅ | Number of requests allowed per interval | 1000 | \ No newline at end of file diff --git a/docs/models/operations/result.mdx b/docs/models/operations/result.mdx index a0a09a424..3dddf26a8 100644 --- a/docs/models/operations/result.mdx +++ b/docs/models/operations/result.mdx @@ -20,6 +20,6 @@ let value: Result = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `document` | [operations.DocumentResponse](../../models/operations/documentresponse.mdx) | :heavy_check_mark: | The document object echoing the original input (text and/or image) | | -| `index` | *number* | :heavy_check_mark: | Index of the document in the original input list | 0 | -| `relevanceScore` | *number* | :heavy_check_mark: | Relevance score of the document to the query | 0.98 | \ No newline at end of file +| `document` | [operations.DocumentResponse](../../models/operations/documentresponse.mdx) | ✅ | The document object echoing the original input (text and/or image) | | +| `index` | *number* | ✅ | Index of the document in the original input list | 0 | +| `relevanceScore` | *number* | ✅ | Relevance score of the document to the query | 0.98 | \ No newline at end of file diff --git a/docs/models/operations/sendchatcompletionrequestglobals.mdx b/docs/models/operations/sendchatcompletionrequestglobals.mdx index 341e4886c..369a23d42 100644 --- a/docs/models/operations/sendchatcompletionrequestglobals.mdx +++ b/docs/models/operations/sendchatcompletionrequestglobals.mdx @@ -14,6 +14,6 @@ let value: SendChatCompletionRequestGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/sendchatcompletionrequestrequest.mdx b/docs/models/operations/sendchatcompletionrequestrequest.mdx index 1b6f6f825..5ab3f7383 100644 --- a/docs/models/operations/sendchatcompletionrequestrequest.mdx +++ b/docs/models/operations/sendchatcompletionrequestrequest.mdx @@ -27,8 +27,8 @@ let value: SendChatCompletionRequestRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `xOpenRouterMetadata` | [models.MetadataLevel](../../models/metadatalevel.mdx) | :heavy_minus_sign: | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | -| `chatRequest` | [models.ChatRequest](../../models/chatrequest.mdx) | :heavy_check_mark: | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `xOpenRouterMetadata` | [models.MetadataLevel](../../models/metadatalevel.mdx) | ➖ | Opt-in to surface routing metadata on the response under `openrouter_metadata`. Defaults to `disabled`. The legacy header `X-OpenRouter-Experimental-Metadata` is also accepted for backward compatibility. | enabled | +| `chatRequest` | [models.ChatRequest](../../models/chatrequest.mdx) | ✅ | N/A | \{
"max_tokens": 150,
"messages": [
\{
"content": "You are a helpful assistant.",
"role": "system"
},
\{
"content": "What is the capital of France?",
"role": "user"
}
],
"model": "openai/gpt-4",
"temperature": 0.7
} | \ No newline at end of file diff --git a/docs/models/operations/storeinternvaultsecretglobals.mdx b/docs/models/operations/storeinternvaultsecretglobals.mdx index e3e5b9ad6..b037663f9 100644 --- a/docs/models/operations/storeinternvaultsecretglobals.mdx +++ b/docs/models/operations/storeinternvaultsecretglobals.mdx @@ -14,6 +14,6 @@ let value: StoreInternVaultSecretGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/storeinternvaultsecretrequest.mdx b/docs/models/operations/storeinternvaultsecretrequest.mdx index 66f15913e..223150147 100644 --- a/docs/models/operations/storeinternvaultsecretrequest.mdx +++ b/docs/models/operations/storeinternvaultsecretrequest.mdx @@ -23,9 +23,9 @@ let value: StoreInternVaultSecretRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `name` | *string* | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `vaultSecretWriteRequest` | [models.VaultSecretWriteRequest](../../models/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | UUID of an intern in the workspace selected by the API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `name` | *string* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `vaultSecretWriteRequest` | [models.VaultSecretWriteRequest](../../models/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file diff --git a/docs/models/operations/storevaultsecretglobals.mdx b/docs/models/operations/storevaultsecretglobals.mdx index 94fd76274..c037b661f 100644 --- a/docs/models/operations/storevaultsecretglobals.mdx +++ b/docs/models/operations/storevaultsecretglobals.mdx @@ -14,6 +14,6 @@ let value: StoreVaultSecretGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/storevaultsecretrequest.mdx b/docs/models/operations/storevaultsecretrequest.mdx index 46f535f5d..c4e3c27da 100644 --- a/docs/models/operations/storevaultsecretrequest.mdx +++ b/docs/models/operations/storevaultsecretrequest.mdx @@ -22,8 +22,8 @@ let value: StoreVaultSecretRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `name` | *string* | :heavy_check_mark: | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | -| `vaultSecretWriteRequest` | [models.VaultSecretWriteRequest](../../models/vaultsecretwriterequest.mdx) | :heavy_check_mark: | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `name` | *string* | ✅ | Secret name. Lowercase letters, digits and single underscores, starting with a letter and not ending with an underscore, 1 to 255 characters. | github_token | +| `vaultSecretWriteRequest` | [models.VaultSecretWriteRequest](../../models/vaultsecretwriterequest.mdx) | ✅ | N/A | \{
"hosts": [
"api.github.com"
],
"value": "ghp_exampleTokenValue"
} | \ No newline at end of file diff --git a/docs/models/operations/submitgenerationfeedbackglobals.mdx b/docs/models/operations/submitgenerationfeedbackglobals.mdx index 13161966e..8cf827456 100644 --- a/docs/models/operations/submitgenerationfeedbackglobals.mdx +++ b/docs/models/operations/submitgenerationfeedbackglobals.mdx @@ -14,6 +14,6 @@ let value: SubmitGenerationFeedbackGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/submitgenerationfeedbackrequest.mdx b/docs/models/operations/submitgenerationfeedbackrequest.mdx index f2cd7ab74..037480ce5 100644 --- a/docs/models/operations/submitgenerationfeedbackrequest.mdx +++ b/docs/models/operations/submitgenerationfeedbackrequest.mdx @@ -19,7 +19,7 @@ let value: SubmitGenerationFeedbackRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `submitGenerationFeedbackRequest` | [models.SubmitGenerationFeedbackRequest](../../models/submitgenerationfeedbackrequest.mdx) | :heavy_check_mark: | N/A | \{
"category": "incorrect_response",
"comment": "The model repeated the same paragraph three times.",
"generation_id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `submitGenerationFeedbackRequest` | [models.SubmitGenerationFeedbackRequest](../../models/submitgenerationfeedbackrequest.mdx) | ✅ | N/A | \{
"category": "incorrect_response",
"comment": "The model repeated the same paragraph three times.",
"generation_id": "gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG"
} | \ No newline at end of file diff --git a/docs/models/operations/suspendinternglobals.mdx b/docs/models/operations/suspendinternglobals.mdx index e09f07545..1e5dbf6c0 100644 --- a/docs/models/operations/suspendinternglobals.mdx +++ b/docs/models/operations/suspendinternglobals.mdx @@ -14,6 +14,6 @@ let value: SuspendInternGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/suspendinternrequest.mdx b/docs/models/operations/suspendinternrequest.mdx index 499ddc06e..dd8981497 100644 --- a/docs/models/operations/suspendinternrequest.mdx +++ b/docs/models/operations/suspendinternrequest.mdx @@ -16,7 +16,7 @@ let value: SuspendInternRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | \ No newline at end of file diff --git a/docs/models/operations/timerange.mdx b/docs/models/operations/timerange.mdx index db735e463..d5d3b6bec 100644 --- a/docs/models/operations/timerange.mdx +++ b/docs/models/operations/timerange.mdx @@ -17,5 +17,5 @@ let value: TimeRange = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `end` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | -| `start` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | \ No newline at end of file +| `end` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | +| `start` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | ISO 8601 UTC timestamp. Must include seconds (YYYY-MM-DDTHH:MM:SSZ; fractional seconds allowed); minute-precision timestamps are rejected. | 2027-12-31T23:59:59Z | \ No newline at end of file diff --git a/docs/models/operations/updatebyokkeyglobals.mdx b/docs/models/operations/updatebyokkeyglobals.mdx index e1a4fa029..9b510ff59 100644 --- a/docs/models/operations/updatebyokkeyglobals.mdx +++ b/docs/models/operations/updatebyokkeyglobals.mdx @@ -14,6 +14,6 @@ let value: UpdateBYOKKeyGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updatebyokkeyrequest.mdx b/docs/models/operations/updatebyokkeyrequest.mdx index 55b9afe5b..1c4f99078 100644 --- a/docs/models/operations/updatebyokkeyrequest.mdx +++ b/docs/models/operations/updatebyokkeyrequest.mdx @@ -17,8 +17,8 @@ let value: UpdateBYOKKeyRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `updateBYOKKeyRequest` | [models.UpdateBYOKKeyRequest](../../models/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | +| `updateBYOKKeyRequest` | [models.UpdateBYOKKeyRequest](../../models/updatebyokkeyrequest.mdx) | ✅ | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file diff --git a/docs/models/operations/updateenduserglobals.mdx b/docs/models/operations/updateenduserglobals.mdx index b59f4abfb..27b35e30b 100644 --- a/docs/models/operations/updateenduserglobals.mdx +++ b/docs/models/operations/updateenduserglobals.mdx @@ -14,6 +14,6 @@ let value: UpdateEndUserGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updateenduserrequest.mdx b/docs/models/operations/updateenduserrequest.mdx index aca63240c..5fc9439b2 100644 --- a/docs/models/operations/updateenduserrequest.mdx +++ b/docs/models/operations/updateenduserrequest.mdx @@ -19,8 +19,8 @@ let value: UpdateEndUserRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `user` | *string* | :heavy_check_mark: | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | -| `updateEndUserRequest` | [models.UpdateEndUserRequest](../../models/updateenduserrequest.mdx) | :heavy_check_mark: | N/A | \{
"is_active": true
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `user` | *string* | ✅ | Immutable case-sensitive tracking string supplied as user on inference requests. URL-encode it in resource paths. | employee_123 | +| `updateEndUserRequest` | [models.UpdateEndUserRequest](../../models/updateenduserrequest.mdx) | ✅ | N/A | \{
"is_active": true
} | \ No newline at end of file diff --git a/docs/models/operations/updateguardrailglobals.mdx b/docs/models/operations/updateguardrailglobals.mdx index dc307bac5..315b8b1a0 100644 --- a/docs/models/operations/updateguardrailglobals.mdx +++ b/docs/models/operations/updateguardrailglobals.mdx @@ -14,6 +14,6 @@ let value: UpdateGuardrailGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updateguardrailrequest.mdx b/docs/models/operations/updateguardrailrequest.mdx index e424c2726..a8b502cf5 100644 --- a/docs/models/operations/updateguardrailrequest.mdx +++ b/docs/models/operations/updateguardrailrequest.mdx @@ -17,8 +17,8 @@ let value: UpdateGuardrailRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `updateGuardrailRequest` | [models.UpdateGuardrailRequest](../../models/updateguardrailrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | +| `updateGuardrailRequest` | [models.UpdateGuardrailRequest](../../models/updateguardrailrequest.mdx) | ✅ | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | \ No newline at end of file diff --git a/docs/models/operations/updateinternglobals.mdx b/docs/models/operations/updateinternglobals.mdx index 2308f39fb..2bbf0fac0 100644 --- a/docs/models/operations/updateinternglobals.mdx +++ b/docs/models/operations/updateinternglobals.mdx @@ -14,6 +14,6 @@ let value: UpdateInternGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updateinternrequest.mdx b/docs/models/operations/updateinternrequest.mdx index fc351a71c..97e3f25f8 100644 --- a/docs/models/operations/updateinternrequest.mdx +++ b/docs/models/operations/updateinternrequest.mdx @@ -17,8 +17,8 @@ let value: UpdateInternRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `internId` | *string* | :heavy_check_mark: | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | -| `updateInternRequest` | [models.UpdateInternRequest](../../models/updateinternrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `internId` | *string* | ✅ | ID of an intern visible to the authenticated API key. | 7c9e6679-7425-40de-944b-e07fc1f90ae7 | +| `updateInternRequest` | [models.UpdateInternRequest](../../models/updateinternrequest.mdx) | ✅ | N/A | \{
"description": "Researches customer questions",
"model": "openai/gpt-5.4"
} | \ No newline at end of file diff --git a/docs/models/operations/updatekeysdata.mdx b/docs/models/operations/updatekeysdata.mdx index a0fc4a85a..092eca211 100644 --- a/docs/models/operations/updatekeysdata.mdx +++ b/docs/models/operations/updatekeysdata.mdx @@ -39,26 +39,26 @@ let value: UpdateKeysData = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byokUsage` | *number* | :heavy_check_mark: | Total external BYOK usage (in USD) for the API key | 17.38 | -| `byokUsageDaily` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC day | 17.38 | -| `byokUsageMonthly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for current UTC month | 17.38 | -| `byokUsageWeekly` | *number* | :heavy_check_mark: | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | -| `creatorUserId` | *string* | :heavy_check_mark: | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | -| `disabled` | *boolean* | :heavy_check_mark: | Whether the API key is disabled | false | -| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | -| `externalUser` | *string* | :heavy_check_mark: | Partner's end-user identifier used for attribution. | null | -| `hash` | *string* | :heavy_check_mark: | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `includeByokInLimit` | *boolean* | :heavy_check_mark: | Whether to include external BYOK usage in the credit limit | false | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the API key | sk-or-v1-0e6...1c96 | -| `lastUsedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | -| `limit` | *number* | :heavy_check_mark: | Spending limit for the API key in USD | 100 | -| `limitRemaining` | *number* | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | -| `limitReset` | *string* | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| `name` | *string* | :heavy_check_mark: | Name of the API key | My Production Key | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | -| `usage` | *number* | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | -| `usageDaily` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | -| `usageMonthly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | -| `usageWeekly` | *number* | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | -| `workspaceId` | *string* | :heavy_check_mark: | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file +| `byokUsage` | *number* | ✅ | Total external BYOK usage (in USD) for the API key | 17.38 | +| `byokUsageDaily` | *number* | ✅ | External BYOK usage (in USD) for the current UTC day | 17.38 | +| `byokUsageMonthly` | *number* | ✅ | External BYOK usage (in USD) for current UTC month | 17.38 | +| `byokUsageWeekly` | *number* | ✅ | External BYOK usage (in USD) for the current UTC week (Monday-Sunday) | 17.38 | +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the API key was created | 2025-08-24T10:30:00Z | +| `creatorUserId` | *string* | ✅ | The user ID of the key creator. For organization-owned keys, this is the member who created the key. For individual users, this is the user's own ID. | user_2dHFtVWx2n56w6HkM0000000000 | +| `disabled` | *boolean* | ✅ | Whether the API key is disabled | false | +| `expiresAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ➖ | ISO 8601 UTC timestamp when the API key expires, or null if no expiration | 2027-12-31T23:59:59Z | +| `externalUser` | *string* | ✅ | Partner's end-user identifier used for attribution. | null | +| `hash` | *string* | ✅ | Unique hash identifier for the API key | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `includeByokInLimit` | *boolean* | ✅ | Whether to include external BYOK usage in the credit limit | false | +| `label` | *string* | ✅ | Human-readable label for the API key | sk-or-v1-0e6...1c96 | +| `lastUsedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | ISO 8601 UTC timestamp of the most recent usage recorded for the API key, or null if no usage has been recorded since the end of 2025 | 2026-09-15T15:45:00Z | +| `limit` | *number* | ✅ | Spending limit for the API key in USD | 100 | +| `limitRemaining` | *number* | ✅ | Remaining spending limit in USD | 74.5 | +| `limitReset` | *string* | ✅ | Type of limit reset for the API key | monthly | +| `name` | *string* | ✅ | Name of the API key | My Production Key | +| `updatedAt` | *string* | ✅ | ISO 8601 timestamp of when the API key was last updated | 2025-08-24T15:45:00Z | +| `usage` | *number* | ✅ | Total OpenRouter credit usage (in USD) for the API key | 25.5 | +| `usageDaily` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | +| `usageMonthly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | +| `usageWeekly` | *number* | ✅ | OpenRouter credit usage (in USD) for the current UTC week (Monday-Sunday) | 25.5 | +| `workspaceId` | *string* | ✅ | The workspace ID this API key belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/operations/updatekeysglobals.mdx b/docs/models/operations/updatekeysglobals.mdx index 64cb3bcfe..5a271efc7 100644 --- a/docs/models/operations/updatekeysglobals.mdx +++ b/docs/models/operations/updatekeysglobals.mdx @@ -14,6 +14,6 @@ let value: UpdateKeysGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updatekeysrequest.mdx b/docs/models/operations/updatekeysrequest.mdx index 9fc33a025..1d5803745 100644 --- a/docs/models/operations/updatekeysrequest.mdx +++ b/docs/models/operations/updatekeysrequest.mdx @@ -17,8 +17,8 @@ let value: UpdateKeysRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `hash` | *string* | :heavy_check_mark: | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `requestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `hash` | *string* | ✅ | The hash identifier of the API key to update | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | +| `requestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody.mdx) | ✅ | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | \ No newline at end of file diff --git a/docs/models/operations/updatekeysrequestbody.mdx b/docs/models/operations/updatekeysrequestbody.mdx index 48d6a8ba8..213cf1e5e 100644 --- a/docs/models/operations/updatekeysrequestbody.mdx +++ b/docs/models/operations/updatekeysrequestbody.mdx @@ -14,8 +14,8 @@ let value: UpdateKeysRequestBody = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `disabled` | *boolean* | :heavy_minus_sign: | Whether to disable the API key | false | -| `includeByokInLimit` | *boolean* | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | -| `limit` | *number* | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `limitReset` | [operations.UpdateKeysLimitReset](../../models/operations/updatekeyslimitreset.mdx) | :heavy_minus_sign: | New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | daily | -| `name` | *string* | :heavy_minus_sign: | New name for the API key | Updated API Key Name | \ No newline at end of file +| `disabled` | *boolean* | ➖ | Whether to disable the API key | false | +| `includeByokInLimit` | *boolean* | ➖ | Whether to include BYOK usage in the limit | true | +| `limit` | *number* | ➖ | New spending limit for the API key in USD | 75 | +| `limitReset` | [operations.UpdateKeysLimitReset](../../models/operations/updatekeyslimitreset.mdx) | ➖ | New limit reset type for the API key (daily, weekly, monthly, or null for no reset). Resets happen automatically at midnight UTC, and weeks are Monday through Sunday. | daily | +| `name` | *string* | ➖ | New name for the API key | Updated API Key Name | \ No newline at end of file diff --git a/docs/models/operations/updatekeysresponse.mdx b/docs/models/operations/updatekeysresponse.mdx index b5b8820da..3450d6b0b 100644 --- a/docs/models/operations/updatekeysresponse.mdx +++ b/docs/models/operations/updatekeysresponse.mdx @@ -41,4 +41,4 @@ let value: UpdateKeysResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [operations.UpdateKeysData](../../models/operations/updatekeysdata.mdx) | :heavy_check_mark: | The updated API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `data` | [operations.UpdateKeysData](../../models/operations/updatekeysdata.mdx) | ✅ | The updated API key information | \{
"byok_usage": 17.38,
"byok_usage_daily": 17.38,
"byok_usage_monthly": 17.38,
"byok_usage_weekly": 17.38,
"created_at": "2025-08-24T10:30:00Z",
"creator_user_id": "user_2dHFtVWx2n56w6HkM0000000000",
"disabled": false,
"expires_at": "2027-12-31T23:59:59Z",
"external_user": null,
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"last_used_at": "2026-09-15T15:45:00Z",
"limit": 100,
"limit_remaining": 74.5,
"limit_reset": "monthly",
"name": "My Production Key",
"updated_at": "2025-08-24T15:45:00Z",
"usage": 25.5,
"usage_daily": 25.5,
"usage_monthly": 25.5,
"usage_weekly": 25.5,
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/operations/updateobservabilitydestinationglobals.mdx b/docs/models/operations/updateobservabilitydestinationglobals.mdx index 57c19157b..4b0afc13a 100644 --- a/docs/models/operations/updateobservabilitydestinationglobals.mdx +++ b/docs/models/operations/updateobservabilitydestinationglobals.mdx @@ -14,6 +14,6 @@ let value: UpdateObservabilityDestinationGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updateobservabilitydestinationrequest.mdx b/docs/models/operations/updateobservabilitydestinationrequest.mdx index 72e84345c..773339120 100644 --- a/docs/models/operations/updateobservabilitydestinationrequest.mdx +++ b/docs/models/operations/updateobservabilitydestinationrequest.mdx @@ -17,8 +17,8 @@ let value: UpdateObservabilityDestinationRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `updateObservabilityDestinationRequest` | [models.UpdateObservabilityDestinationRequest](../../models/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | +| `updateObservabilityDestinationRequest` | [models.UpdateObservabilityDestinationRequest](../../models/updateobservabilitydestinationrequest.mdx) | ✅ | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file diff --git a/docs/models/operations/updateorganizationsettingsglobals.mdx b/docs/models/operations/updateorganizationsettingsglobals.mdx index 1f0b3bb89..71a6329a3 100644 --- a/docs/models/operations/updateorganizationsettingsglobals.mdx +++ b/docs/models/operations/updateorganizationsettingsglobals.mdx @@ -14,6 +14,6 @@ let value: UpdateOrganizationSettingsGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updateorganizationsettingsrequest.mdx b/docs/models/operations/updateorganizationsettingsrequest.mdx index 27c4675ab..ef7906090 100644 --- a/docs/models/operations/updateorganizationsettingsrequest.mdx +++ b/docs/models/operations/updateorganizationsettingsrequest.mdx @@ -18,7 +18,7 @@ let value: UpdateOrganizationSettingsRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `updateOrganizationSettingsRequest` | [models.UpdateOrganizationSettingsRequest](../../models/updateorganizationsettingsrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `updateOrganizationSettingsRequest` | [models.UpdateOrganizationSettingsRequest](../../models/updateorganizationsettingsrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/updateorganizationsettingsresponse.mdx b/docs/models/operations/updateorganizationsettingsresponse.mdx index 38613fbc8..684914dd8 100644 --- a/docs/models/operations/updateorganizationsettingsresponse.mdx +++ b/docs/models/operations/updateorganizationsettingsresponse.mdx @@ -21,4 +21,4 @@ let value: UpdateOrganizationSettingsResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `data` | [models.OrganizationSettings](../../models/organizationsettings.mdx) | :heavy_check_mark: | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file +| `data` | [models.OrganizationSettings](../../models/organizationsettings.mdx) | ✅ | N/A | \{
"id": "org_2dHFtVWx2n56w6HkM0000000000",
"is_filtered_model_catalog_enabled": true
} | \ No newline at end of file diff --git a/docs/models/operations/updateprivateendpointglobals.mdx b/docs/models/operations/updateprivateendpointglobals.mdx index 94830e0d8..b392a0a6d 100644 --- a/docs/models/operations/updateprivateendpointglobals.mdx +++ b/docs/models/operations/updateprivateendpointglobals.mdx @@ -14,6 +14,6 @@ let value: UpdatePrivateEndpointGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updateprivateendpointpricingglobals.mdx b/docs/models/operations/updateprivateendpointpricingglobals.mdx index acdb1211b..195f0832c 100644 --- a/docs/models/operations/updateprivateendpointpricingglobals.mdx +++ b/docs/models/operations/updateprivateendpointpricingglobals.mdx @@ -14,6 +14,6 @@ let value: UpdatePrivateEndpointPricingGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updateprivateendpointpricingrequest.mdx b/docs/models/operations/updateprivateendpointpricingrequest.mdx index c478f8574..6de257e68 100644 --- a/docs/models/operations/updateprivateendpointpricingrequest.mdx +++ b/docs/models/operations/updateprivateendpointpricingrequest.mdx @@ -22,8 +22,8 @@ let value: UpdatePrivateEndpointPricingRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `updatePrivateEndpointPricingRequest` | [models.UpdatePrivateEndpointPricingRequest](../../models/updateprivateendpointpricingrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `updatePrivateEndpointPricingRequest` | [models.UpdatePrivateEndpointPricingRequest](../../models/updateprivateendpointpricingrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/updateprivateendpointrequest.mdx b/docs/models/operations/updateprivateendpointrequest.mdx index bfaf53ce6..6b2e03298 100644 --- a/docs/models/operations/updateprivateendpointrequest.mdx +++ b/docs/models/operations/updateprivateendpointrequest.mdx @@ -19,8 +19,8 @@ let value: UpdatePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `updatePrivateEndpointRequest` | [models.UpdatePrivateEndpointRequest](../../models/updateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `updatePrivateEndpointRequest` | [models.UpdatePrivateEndpointRequest](../../models/updateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/updatescimgroupmappingglobals.mdx b/docs/models/operations/updatescimgroupmappingglobals.mdx index 36279eadd..694046962 100644 --- a/docs/models/operations/updatescimgroupmappingglobals.mdx +++ b/docs/models/operations/updatescimgroupmappingglobals.mdx @@ -14,6 +14,6 @@ let value: UpdateScimGroupMappingGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updatescimgroupmappingrequest.mdx b/docs/models/operations/updatescimgroupmappingrequest.mdx index 9e03f03f1..da18b7449 100644 --- a/docs/models/operations/updatescimgroupmappingrequest.mdx +++ b/docs/models/operations/updatescimgroupmappingrequest.mdx @@ -19,8 +19,8 @@ let value: UpdateScimGroupMappingRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| -| `id` | *string* | :heavy_check_mark: | N/A | -| `updateScimGroupMappingRequest` | [models.UpdateScimGroupMappingRequest](../../models/updatescimgroupmappingrequest.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| +| `id` | *string* | ✅ | N/A | +| `updateScimGroupMappingRequest` | [models.UpdateScimGroupMappingRequest](../../models/updatescimgroupmappingrequest.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/updateworkspaceglobals.mdx b/docs/models/operations/updateworkspaceglobals.mdx index 69775017c..0d69e8acd 100644 --- a/docs/models/operations/updateworkspaceglobals.mdx +++ b/docs/models/operations/updateworkspaceglobals.mdx @@ -14,6 +14,6 @@ let value: UpdateWorkspaceGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/updateworkspacerequest.mdx b/docs/models/operations/updateworkspacerequest.mdx index 3e42ff583..3b26ee6f1 100644 --- a/docs/models/operations/updateworkspacerequest.mdx +++ b/docs/models/operations/updateworkspacerequest.mdx @@ -17,8 +17,8 @@ let value: UpdateWorkspaceRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `updateWorkspaceRequest` | [models.UpdateWorkspaceRequest](../../models/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | The workspace ID (UUID) or slug | production | +| `updateWorkspaceRequest` | [models.UpdateWorkspaceRequest](../../models/updateworkspacerequest.mdx) | ✅ | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file diff --git a/docs/models/operations/uploadfilefile.mdx b/docs/models/operations/uploadfilefile.mdx index af1ae578f..fcdccf3a2 100644 --- a/docs/models/operations/uploadfilefile.mdx +++ b/docs/models/operations/uploadfilefile.mdx @@ -14,5 +14,5 @@ import { UploadFileFile } from "@openrouter/sdk/models/operations"; | Field | Type | Required | Description | | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `fileName` | *string* | :heavy_check_mark: | N/A | -| `content` | *ReadableStream\* | :heavy_check_mark: | N/A | \ No newline at end of file +| `fileName` | *string* | ✅ | N/A | +| `content` | *ReadableStream\* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/uploadfileglobals.mdx b/docs/models/operations/uploadfileglobals.mdx index e66dad057..1fd99c295 100644 --- a/docs/models/operations/uploadfileglobals.mdx +++ b/docs/models/operations/uploadfileglobals.mdx @@ -14,6 +14,6 @@ let value: UploadFileGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequest.mdx b/docs/models/operations/uploadfilerequest.mdx index 479920f14..a4e63b5e3 100644 --- a/docs/models/operations/uploadfilerequest.mdx +++ b/docs/models/operations/uploadfilerequest.mdx @@ -14,9 +14,9 @@ import { UploadFileRequest } from "@openrouter/sdk/models/operations"; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspaceId` | *string* | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | :heavy_minus_sign: | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | -| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspaceId` | *string* | ➖ | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | +| `provider` | [models.FileProvider](../../models/fileprovider.mdx) | ➖ | Store or read this file on the named provider using your own API key for it. Omit to use OpenRouter storage. | openai | +| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequestbody.mdx b/docs/models/operations/uploadfilerequestbody.mdx index 8c2604b14..27bcd051f 100644 --- a/docs/models/operations/uploadfilerequestbody.mdx +++ b/docs/models/operations/uploadfilerequestbody.mdx @@ -14,4 +14,4 @@ import { UploadFileRequestBody } from "@openrouter/sdk/models/operations"; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.UploadFileFile](../../models/operations/uploadfilefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `file` | [File](https://developer.mozilla.org/en-US/docs/Web/API/File) \| [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) \| [operations.UploadFileFile](../../models/operations/uploadfilefile.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/operations/upsertworkspacebudgetglobals.mdx b/docs/models/operations/upsertworkspacebudgetglobals.mdx index 27a790aa0..89a78a704 100644 --- a/docs/models/operations/upsertworkspacebudgetglobals.mdx +++ b/docs/models/operations/upsertworkspacebudgetglobals.mdx @@ -14,6 +14,6 @@ let value: UpsertWorkspaceBudgetGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/upsertworkspacebudgetrequest.mdx b/docs/models/operations/upsertworkspacebudgetrequest.mdx index 45ac1e6fc..05f6f73c3 100644 --- a/docs/models/operations/upsertworkspacebudgetrequest.mdx +++ b/docs/models/operations/upsertworkspacebudgetrequest.mdx @@ -20,9 +20,9 @@ let value: UpsertWorkspaceBudgetRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `workspaceRef` | *string* | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [models.WorkspaceBudgetInterval](../../models/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `upsertWorkspaceBudgetRequest` | [models.UpsertWorkspaceBudgetRequest](../../models/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `workspaceRef` | *string* | ✅ | The workspace ID (UUID) or slug | production | +| `interval` | [models.WorkspaceBudgetInterval](../../models/workspacebudgetinterval.mdx) | ✅ | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `upsertWorkspaceBudgetRequest` | [models.UpsertWorkspaceBudgetRequest](../../models/upsertworkspacebudgetrequest.mdx) | ✅ | N/A | \{
"include_byok_in_budgets": true,
"limit_usd": 100
} | \ No newline at end of file diff --git a/docs/models/operations/validateprivateendpointglobals.mdx b/docs/models/operations/validateprivateendpointglobals.mdx index 0c0a95fd7..ac46275ed 100644 --- a/docs/models/operations/validateprivateendpointglobals.mdx +++ b/docs/models/operations/validateprivateendpointglobals.mdx @@ -14,6 +14,6 @@ let value: ValidatePrivateEndpointGlobals = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| \ No newline at end of file diff --git a/docs/models/operations/validateprivateendpointrequest.mdx b/docs/models/operations/validateprivateendpointrequest.mdx index eed9e1298..59c081984 100644 --- a/docs/models/operations/validateprivateendpointrequest.mdx +++ b/docs/models/operations/validateprivateendpointrequest.mdx @@ -19,8 +19,8 @@ let value: ValidatePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `httpReferer` | *string* | :heavy_minus_sign: | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | -| `appTitle` | *string* | :heavy_minus_sign: | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | -| `appCategories` | *string* | :heavy_minus_sign: | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `validatePrivateEndpointRequest` | [models.ValidatePrivateEndpointRequest](../../models/validateprivateendpointrequest.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `httpReferer` | *string* | ➖ | The app identifier should be your app's URL and is used as the primary identifier for rankings.
This is used to track API usage per application.
| | +| `appTitle` | *string* | ➖ | The app display name allows you to customize how your app appears in OpenRouter's dashboard.
| | +| `appCategories` | *string* | ➖ | Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
| | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `validatePrivateEndpointRequest` | [models.ValidatePrivateEndpointRequest](../../models/validateprivateendpointrequest.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/oranthropicbashtoolresult.mdx b/docs/models/oranthropicbashtoolresult.mdx index 8fc96b2fc..3eb68e5be 100644 --- a/docs/models/oranthropicbashtoolresult.mdx +++ b/docs/models/oranthropicbashtoolresult.mdx @@ -20,8 +20,8 @@ let value: ORAnthropicBashToolResult = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `content` | Record\ | :heavy_check_mark: | N/A | -| `files` | [models.ORAnthropicBashToolResultFile](../models/oranthropicbashtoolresultfile.mdx)[] | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"openrouter_bash_tool_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `content` | Record\ | ✅ | N/A | +| `files` | [models.ORAnthropicBashToolResultFile](../models/oranthropicbashtoolresultfile.mdx)[] | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `toolUseId` | *string* | ✅ | N/A | +| `type` | *"openrouter_bash_tool_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/oranthropicbashtoolresultfile.mdx b/docs/models/oranthropicbashtoolresultfile.mdx index 9cd8bb363..1789bba26 100644 --- a/docs/models/oranthropicbashtoolresultfile.mdx +++ b/docs/models/oranthropicbashtoolresultfile.mdx @@ -21,9 +21,9 @@ let value: ORAnthropicBashToolResultFile = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_check_mark: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.ORAnthropicBashToolResultTypeContainerFileCitation](../models/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ✅ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `type` | [models.ORAnthropicBashToolResultTypeContainerFileCitation](../models/oranthropicbashtoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/oranthropicservertooluseblock.mdx b/docs/models/oranthropicservertooluseblock.mdx index 68769f715..7560dad38 100644 --- a/docs/models/oranthropicservertooluseblock.mdx +++ b/docs/models/oranthropicservertooluseblock.mdx @@ -18,8 +18,8 @@ let value: ORAnthropicServerToolUseBlock = { | Field | Type | Required | Description | Example | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `caller` | *models.ORAnthropicNullableCaller* | :heavy_minus_sign: | N/A | \{
"type": "direct"
} | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `input` | *any* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"server_tool_use"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `caller` | *models.ORAnthropicNullableCaller* | ➖ | N/A | \{
"type": "direct"
} | +| `id` | *string* | ✅ | N/A | | +| `input` | *any* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `type` | *"server_tool_use"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/oranthropicshelltoolresult.mdx b/docs/models/oranthropicshelltoolresult.mdx index 08317a814..eed9843e0 100644 --- a/docs/models/oranthropicshelltoolresult.mdx +++ b/docs/models/oranthropicshelltoolresult.mdx @@ -24,8 +24,8 @@ let value: ORAnthropicShellToolResult = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | -| `content` | Record\ | :heavy_check_mark: | N/A | -| `files` | [models.ORAnthropicShellToolResultFile](../models/oranthropicshelltoolresultfile.mdx)[] | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | -| `toolUseId` | *string* | :heavy_check_mark: | N/A | -| `type` | *"openrouter_shell_tool_result"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | +| `content` | Record\ | ✅ | N/A | +| `files` | [models.ORAnthropicShellToolResultFile](../models/oranthropicshelltoolresultfile.mdx)[] | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | +| `toolUseId` | *string* | ✅ | N/A | +| `type` | *"openrouter_shell_tool_result"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/oranthropicshelltoolresultfile.mdx b/docs/models/oranthropicshelltoolresultfile.mdx index 40d24e1bb..82409b3f7 100644 --- a/docs/models/oranthropicshelltoolresultfile.mdx +++ b/docs/models/oranthropicshelltoolresultfile.mdx @@ -21,9 +21,9 @@ let value: ORAnthropicShellToolResultFile = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | -| `containerId` | *string* | :heavy_check_mark: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.ORAnthropicShellToolResultTypeContainerFileCitation](../models/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ✅ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `type` | [models.ORAnthropicShellToolResultTypeContainerFileCitation](../models/oranthropicshelltoolresulttypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/organizationsettings.mdx b/docs/models/organizationsettings.mdx index 67a9e5072..5598b9ee3 100644 --- a/docs/models/organizationsettings.mdx +++ b/docs/models/organizationsettings.mdx @@ -17,5 +17,5 @@ let value: OrganizationSettings = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | -| `isFilteredModelCatalogEnabled` | *boolean* | :heavy_check_mark: | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file +| `id` | *string* | ✅ | ID of the organization the settings belong to | org_2dHFtVWx2n56w6HkM0000000000 | +| `isFilteredModelCatalogEnabled` | *boolean* | ✅ | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file diff --git a/docs/models/outcomeexit.mdx b/docs/models/outcomeexit.mdx index 4c0c44937..18adecfe7 100644 --- a/docs/models/outcomeexit.mdx +++ b/docs/models/outcomeexit.mdx @@ -17,6 +17,6 @@ let value: OutcomeExit = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `exitCode` | *number* | :heavy_check_mark: | N/A | -| `type` | *"exit"* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `exitCode` | *number* | ✅ | N/A | +| `type` | *"exit"* | ✅ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/outcometimeout.mdx b/docs/models/outcometimeout.mdx index bc1f04190..06bdfd67f 100644 --- a/docs/models/outcometimeout.mdx +++ b/docs/models/outcometimeout.mdx @@ -16,5 +16,5 @@ let value: OutcomeTimeout = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `type` | *"timeout"* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *"timeout"* | ✅ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/outputadvisorservertoolitem.mdx b/docs/models/outputadvisorservertoolitem.mdx index 90e3f6daf..ea18f4e18 100644 --- a/docs/models/outputadvisorservertoolitem.mdx +++ b/docs/models/outputadvisorservertoolitem.mdx @@ -19,11 +19,11 @@ let value: OutputAdvisorServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `advice` | *string* | :heavy_minus_sign: | The advisor model's response (the advice text returned to the executor). | | -| `error` | *string* | :heavy_minus_sign: | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `instanceName` | *string* | :heavy_minus_sign: | Provider-safe function name of the specific advisor instance that produced this item (e.g. `openrouter_advisor__1`). Present only when more than one advisor tool is configured; omitted for the default single advisor. Echo this field back unchanged so the advisor's cross-request memory stays namespaced to the correct instance. This identity is positional: it is derived from the index of the advisor entry in the request `tools` array, so clients must keep the order of advisor tool entries stable across requests in a conversation. Reordering or inserting advisor entries shifts these names and causes each advisor's cross-request memory to be attributed to the wrong instance. | openrouter_advisor__1 | -| `model` | *string* | :heavy_minus_sign: | Slug of the advisor model that was consulted. | | -| `prompt` | *string* | :heavy_minus_sign: | The prompt the executor sent to the advisor. | | -| `status` | [models.FailableToolCallStatus](../models/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputAdvisorServerToolItemType](../models/outputadvisorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `advice` | *string* | ➖ | The advisor model's response (the advice text returned to the executor). | | +| `error` | *string* | ➖ | Error message when the advisor call did not produce advice. Set together with `status: 'failed'` on the terminal item. | | +| `id` | *string* | ➖ | N/A | | +| `instanceName` | *string* | ➖ | Provider-safe function name of the specific advisor instance that produced this item (e.g. `openrouter_advisor__1`). Present only when more than one advisor tool is configured; omitted for the default single advisor. Echo this field back unchanged so the advisor's cross-request memory stays namespaced to the correct instance. This identity is positional: it is derived from the index of the advisor entry in the request `tools` array, so clients must keep the order of advisor tool entries stable across requests in a conversation. Reordering or inserting advisor entries shifts these names and causes each advisor's cross-request memory to be attributed to the wrong instance. | openrouter_advisor__1 | +| `model` | *string* | ➖ | Slug of the advisor model that was consulted. | | +| `prompt` | *string* | ➖ | The prompt the executor sent to the advisor. | | +| `status` | [models.FailableToolCallStatus](../models/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputAdvisorServerToolItemType](../models/outputadvisorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputapplypatchcallitem.mdx b/docs/models/outputapplypatchcallitem.mdx index b3d2c3dbc..c401d0012 100644 --- a/docs/models/outputapplypatchcallitem.mdx +++ b/docs/models/outputapplypatchcallitem.mdx @@ -26,8 +26,8 @@ let value: OutputApplyPatchCallItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `operation` | *models.ApplyPatchCallOperation* | :heavy_check_mark: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | -| `status` | [models.ApplyPatchCallStatus](../models/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `type` | *"apply_patch_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `operation` | *models.ApplyPatchCallOperation* | ✅ | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | +| `status` | [models.ApplyPatchCallStatus](../models/applypatchcallstatus.mdx) | ✅ | Lifecycle state of an `apply_patch_call` output item. | completed | +| `type` | *"apply_patch_call"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputapplypatchservertoolitem.mdx b/docs/models/outputapplypatchservertoolitem.mdx index b9f17b662..62d10b90d 100644 --- a/docs/models/outputapplypatchservertoolitem.mdx +++ b/docs/models/outputapplypatchservertoolitem.mdx @@ -19,8 +19,8 @@ let value: OutputApplyPatchServerToolItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `operation` | *models.ApplyPatchCallOperation* | :heavy_minus_sign: | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputApplyPatchServerToolItemType](../models/outputapplypatchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `callId` | *string* | ➖ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `operation` | *models.ApplyPatchCallOperation* | ➖ | The patch operation requested by an `apply_patch_call`. `create_file` and `update_file` carry a V4A diff; `delete_file` omits it. | \{
"diff": "@@ function main() \{\n+ console.log(\"hi\");\n }",
"path": "/src/main.ts",
"type": "update_file"
} | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputApplyPatchServerToolItemType](../models/outputapplypatchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputbashservertoolitem.mdx b/docs/models/outputbashservertoolitem.mdx index 39d1c54f7..207ad0c73 100644 --- a/docs/models/outputbashservertoolitem.mdx +++ b/docs/models/outputbashservertoolitem.mdx @@ -19,15 +19,15 @@ let value: OutputBashServerToolItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | -| `callId` | *string* | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | -| `command` | *string* | :heavy_minus_sign: | N/A | | -| `containerId` | *string* | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `error` | *string* | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. A non-zero `exitCode` is a command failure, not a tool failure. | | -| `exitCode` | *number* | :heavy_minus_sign: | N/A | | -| `files` | [models.OutputBashServerToolItemFile](../models/outputbashservertoolitemfile.mdx)[] | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.FailableToolCallStatus](../models/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `stderr` | *string* | :heavy_minus_sign: | N/A | | -| `stdout` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputBashServerToolItemTypeOpenrouterBash](../models/outputbashservertoolitemtypeopenrouterbash.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *string* | ➖ | The raw tool-call arguments string as emitted by the model. | | +| `callId` | *string* | ➖ | The model-generated tool call id from the originating turn. | | +| `command` | *string* | ➖ | N/A | | +| `containerId` | *string* | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `error` | *string* | ➖ | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. A non-zero `exitCode` is a command failure, not a tool failure. | | +| `exitCode` | *number* | ➖ | N/A | | +| `files` | [models.OutputBashServerToolItemFile](../models/outputbashservertoolitemfile.mdx)[] | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `id` | *string* | ➖ | N/A | | +| `status` | [models.FailableToolCallStatus](../models/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `stderr` | *string* | ➖ | N/A | | +| `stdout` | *string* | ➖ | N/A | | +| `type` | [models.OutputBashServerToolItemTypeOpenrouterBash](../models/outputbashservertoolitemtypeopenrouterbash.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputbashservertoolitemfile.mdx b/docs/models/outputbashservertoolitemfile.mdx index d6b0a88e0..02a7a1f21 100644 --- a/docs/models/outputbashservertoolitemfile.mdx +++ b/docs/models/outputbashservertoolitemfile.mdx @@ -21,9 +21,9 @@ let value: OutputBashServerToolItemFile = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_check_mark: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.OutputBashServerToolItemTypeContainerFileCitation](../models/outputbashservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ✅ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `type` | [models.OutputBashServerToolItemTypeContainerFileCitation](../models/outputbashservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputbrowseruseservertoolitem.mdx b/docs/models/outputbrowseruseservertoolitem.mdx index b32129b62..596f49e5f 100644 --- a/docs/models/outputbrowseruseservertoolitem.mdx +++ b/docs/models/outputbrowseruseservertoolitem.mdx @@ -19,8 +19,8 @@ let value: OutputBrowserUseServerToolItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `action` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `screenshotB64` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputBrowserUseServerToolItemType](../models/outputbrowseruseservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | *string* | ➖ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `screenshotB64` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputBrowserUseServerToolItemType](../models/outputbrowseruseservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputcodeinterpretercallitem.mdx b/docs/models/outputcodeinterpretercallitem.mdx index d38449c5e..a5e591bd7 100644 --- a/docs/models/outputcodeinterpretercallitem.mdx +++ b/docs/models/outputcodeinterpretercallitem.mdx @@ -20,10 +20,10 @@ let value: OutputCodeInterpreterCallItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *string* | :heavy_minus_sign: | N/A | | -| `containerId` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `outputs` | *models.OutputCodeInterpreterCallItemOutput*[] | :heavy_minus_sign: | N/A | | -| `status` | [models.OutputCodeInterpreterCallItemStatus](../models/outputcodeinterpretercallitemstatus.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.OutputCodeInterpreterCallItemType](../models/outputcodeinterpretercallitemtype.mdx) | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file +| `code` | *string* | ➖ | N/A | | +| `containerId` | *string* | ➖ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `outputs` | *models.OutputCodeInterpreterCallItemOutput*[] | ➖ | N/A | | +| `status` | [models.OutputCodeInterpreterCallItemStatus](../models/outputcodeinterpretercallitemstatus.mdx) | ✅ | N/A | | +| `type` | [models.OutputCodeInterpreterCallItemType](../models/outputcodeinterpretercallitemtype.mdx) | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file diff --git a/docs/models/outputcodeinterpreterservertoolitem.mdx b/docs/models/outputcodeinterpreterservertoolitem.mdx index dde7b1d1a..e314d15a4 100644 --- a/docs/models/outputcodeinterpreterservertoolitem.mdx +++ b/docs/models/outputcodeinterpreterservertoolitem.mdx @@ -19,11 +19,11 @@ let value: OutputCodeInterpreterServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `code` | *string* | :heavy_minus_sign: | N/A | | -| `exitCode` | *number* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `language` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `stderr` | *string* | :heavy_minus_sign: | N/A | | -| `stdout` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputCodeInterpreterServerToolItemType](../models/outputcodeinterpreterservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `code` | *string* | ➖ | N/A | | +| `exitCode` | *number* | ➖ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `language` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `stderr` | *string* | ➖ | N/A | | +| `stdout` | *string* | ➖ | N/A | | +| `type` | [models.OutputCodeInterpreterServerToolItemType](../models/outputcodeinterpreterservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputcomputercallitem.mdx b/docs/models/outputcomputercallitem.mdx index 507d34ec3..8de0e762c 100644 --- a/docs/models/outputcomputercallitem.mdx +++ b/docs/models/outputcomputercallitem.mdx @@ -19,9 +19,9 @@ let value: OutputComputerCallItem = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `action` | *any* | :heavy_minus_sign: | N/A | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_minus_sign: | N/A | -| `pendingSafetyChecks` | [models.PendingSafetyCheck](../models/pendingsafetycheck.mdx)[] | :heavy_check_mark: | N/A | -| `status` | [models.OutputComputerCallItemStatus](../models/outputcomputercallitemstatus.mdx) | :heavy_check_mark: | N/A | -| `type` | [models.OutputComputerCallItemType](../models/outputcomputercallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `action` | *any* | ➖ | N/A | +| `callId` | *string* | ✅ | N/A | +| `id` | *string* | ➖ | N/A | +| `pendingSafetyChecks` | [models.PendingSafetyCheck](../models/pendingsafetycheck.mdx)[] | ✅ | N/A | +| `status` | [models.OutputComputerCallItemStatus](../models/outputcomputercallitemstatus.mdx) | ✅ | N/A | +| `type` | [models.OutputComputerCallItemType](../models/outputcomputercallitemtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputcustomtoolcallitem.mdx b/docs/models/outputcustomtoolcallitem.mdx index 65f81dd2a..7f83163f9 100644 --- a/docs/models/outputcustomtoolcallitem.mdx +++ b/docs/models/outputcustomtoolcallitem.mdx @@ -21,11 +21,11 @@ let value: OutputCustomToolCallItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `async` | *boolean* | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `input` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [models.OutputCustomToolCallItemStatus](../models/outputcustomtoolcallitemstatus.mdx) | :heavy_minus_sign: | N/A | | -| `type` | *"custom_tool_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async` | *boolean* | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `input` | *string* | ✅ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `namespace` | *string* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [models.OutputCustomToolCallItemStatus](../models/outputcustomtoolcallitemstatus.mdx) | ➖ | N/A | | +| `type` | *"custom_tool_call"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputdatetimeitem.mdx b/docs/models/outputdatetimeitem.mdx index a77992945..0444f14d0 100644 --- a/docs/models/outputdatetimeitem.mdx +++ b/docs/models/outputdatetimeitem.mdx @@ -21,8 +21,8 @@ let value: OutputDatetimeItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `datetime` | *string* | :heavy_check_mark: | ISO 8601 datetime string | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `timezone` | *string* | :heavy_check_mark: | IANA timezone name | | -| `type` | [models.OutputDatetimeItemType](../models/outputdatetimeitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `datetime` | *string* | ✅ | ISO 8601 datetime string | | +| `id` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `timezone` | *string* | ✅ | IANA timezone name | | +| `type` | [models.OutputDatetimeItemType](../models/outputdatetimeitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputfilesearchcallitem.mdx b/docs/models/outputfilesearchcallitem.mdx index a4b69149f..a8909c885 100644 --- a/docs/models/outputfilesearchcallitem.mdx +++ b/docs/models/outputfilesearchcallitem.mdx @@ -23,7 +23,7 @@ let value: OutputFileSearchCallItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `queries` | *string*[] | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFileSearchCallItemType](../models/outputfilesearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *string* | ✅ | N/A | | +| `queries` | *string*[] | ✅ | N/A | | +| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputFileSearchCallItemType](../models/outputfilesearchcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputfilesearchservertoolitem.mdx b/docs/models/outputfilesearchservertoolitem.mdx index 39c2676cc..0735e418d 100644 --- a/docs/models/outputfilesearchservertoolitem.mdx +++ b/docs/models/outputfilesearchservertoolitem.mdx @@ -19,7 +19,7 @@ let value: OutputFileSearchServerToolItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `queries` | *string*[] | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFileSearchServerToolItemType](../models/outputfilesearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *string* | ➖ | N/A | | +| `queries` | *string*[] | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputFileSearchServerToolItemType](../models/outputfilesearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputfilesservertoolitem.mdx b/docs/models/outputfilesservertoolitem.mdx index cbd494ab9..fdc14af13 100644 --- a/docs/models/outputfilesservertoolitem.mdx +++ b/docs/models/outputfilesservertoolitem.mdx @@ -19,13 +19,13 @@ let value: OutputFilesServerToolItem = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | -| `callId` | *string* | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | -| `error` | *string* | :heavy_minus_sign: | Error message when the file operation failed. | | -| `fileId` | *string* | :heavy_minus_sign: | The target file id supplied in the tool-call arguments. | | -| `filename` | *string* | :heavy_minus_sign: | The target filename supplied in the tool-call arguments. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `operation` | *string* | :heavy_minus_sign: | The file operation performed (list, read, write, or edit). | | -| `result` | *string* | :heavy_minus_sign: | JSON-serialized result of the file operation. | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFilesServerToolItemType](../models/outputfilesservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *string* | ➖ | The raw tool-call arguments string as emitted by the model. | | +| `callId` | *string* | ➖ | The model-generated tool call id from the originating turn. | | +| `error` | *string* | ➖ | Error message when the file operation failed. | | +| `fileId` | *string* | ➖ | The target file id supplied in the tool-call arguments. | | +| `filename` | *string* | ➖ | The target filename supplied in the tool-call arguments. | | +| `id` | *string* | ➖ | N/A | | +| `operation` | *string* | ➖ | The file operation performed (list, read, write, or edit). | | +| `result` | *string* | ➖ | JSON-serialized result of the file operation. | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputFilesServerToolItemType](../models/outputfilesservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputfunctioncallitem.mdx b/docs/models/outputfunctioncallitem.mdx index 9e720ebee..f589390a5 100644 --- a/docs/models/outputfunctioncallitem.mdx +++ b/docs/models/outputfunctioncallitem.mdx @@ -19,13 +19,13 @@ let value: OutputFunctionCallItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `async` | *boolean* | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | *models.OutputFunctionCallItemStatusUnion* | :heavy_minus_sign: | N/A | | -| `type` | *"function_call"* | :heavy_check_mark: | N/A | | -| `subagentId` | *string* | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | -| `subagentItems` | [models.OutputFunctionCallItemSubagentItem](../models/outputfunctioncallitemsubagentitem.mdx)[] | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | | +| `async` | *boolean* | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `namespace` | *string* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | *models.OutputFunctionCallItemStatusUnion* | ➖ | N/A | | +| `type` | *"function_call"* | ✅ | N/A | | +| `subagentId` | *string* | ➖ | EXPERIMENTAL — subject to change without notice. String id that matches the `call_id` of the `openrouter:subagent` server tool call that spawned the subagent. Present on every `function_call` item the subagent projects; absent on ordinary function calls. | | +| `subagentItems` | [models.OutputFunctionCallItemSubagentItem](../models/outputfunctioncallitemsubagentitem.mdx)[] | ➖ | EXPERIMENTAL — subject to change without notice. The subagent's output items produced on this turn. Treat this as an opaque object; you must replay it in the request so that the subagent can continue execution of the tool with the same context. If a subagent created multiple parallel tool calls, only the first tool call will have this field. The other tool calls will only have `subagent_id`. Present only if the tool call originates from a subagent spawned by the `openrouter:subagent` server tool. | | \ No newline at end of file diff --git a/docs/models/outputfunctioncallitemsubagentitem.mdx b/docs/models/outputfunctioncallitemsubagentitem.mdx index 27d155afa..bf705cbc6 100644 --- a/docs/models/outputfunctioncallitemsubagentitem.mdx +++ b/docs/models/outputfunctioncallitemsubagentitem.mdx @@ -16,5 +16,5 @@ let value: OutputFunctionCallItemSubagentItem = { | Field | Type | Required | Description | | ---------------------- | ---------------------- | ---------------------- | ---------------------- | -| `type` | *string* | :heavy_check_mark: | N/A | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *string* | ✅ | N/A | +| `additionalProperties` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/outputfusionservertoolitem.mdx b/docs/models/outputfusionservertoolitem.mdx index d2a1a65c4..22f3dfe37 100644 --- a/docs/models/outputfusionservertoolitem.mdx +++ b/docs/models/outputfusionservertoolitem.mdx @@ -19,12 +19,12 @@ let value: OutputFusionServerToolItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `analysis` | [models.FusionAnalysisResult](../models/fusionanalysisresult.mdx) | :heavy_minus_sign: | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | -| `error` | *string* | :heavy_minus_sign: | Error message when the fusion run did not produce an analysis result. | | -| `failedModels` | [models.FailedModel](../models/failedmodel.mdx)[] | :heavy_minus_sign: | Models that were requested as part of the analysis panel but did not produce a response. Present when at least one requested analysis model failed. On a completed item the fusion result is still usable but was produced from a degraded panel; on a failed item it lists the panels that failed before the run stopped, so the caller can see which models were attempted even though no analysis was produced. | | -| `failureReason` | *string* | :heavy_minus_sign: | Typed failure reason when the fusion run failed. Possible values include: all_panels_failed, insufficient_credits, rate_limited, invalid_model, judge_not_valid_json, judge_schema_mismatch, judge_upstream_error, judge_empty_completion. The four analysis-stage codes keep their pre-rename `judge_` spelling so existing consumers keep matching. The consumer-cancellation code is `cancelled`. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `responses` | [models.OutputFusionServerToolItemResponse](../models/outputfusionservertoolitemresponse.mdx)[] | :heavy_minus_sign: | Analysis models that produced a response in this fusion run, with each model's full panel content. | | -| `sources` | [models.FusionSource](../models/fusionsource.mdx)[] | :heavy_minus_sign: | Web pages the analysis panels and analyst retrieved via web search during this fusion run, deduplicated by URL across the whole run. Present when at least one model cited a source. | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputFusionServerToolItemType](../models/outputfusionservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `analysis` | [models.FusionAnalysisResult](../models/fusionanalysisresult.mdx) | ➖ | Structured analysis produced by the fusion analyst model. | \{
"blind_spots": [
"No model considered the impact on existing API consumers."
],
"consensus": [
"All panel models agree the request is asking for a concise summary."
],
"contradictions": [
\{
"stances": [
\{
"model": "openai/gpt-5",
"stance": "Favors an incremental rollout."
},
\{
"model": "anthropic/claude-sonnet-4.5",
"stance": "Favors a single coordinated migration."
}
],
"topic": "Recommended approach"
}
],
"partial_coverage": [
\{
"models": [
"openai/gpt-5"
],
"point": "Only one model addressed the rollback strategy."
}
],
"unique_insights": [
\{
"insight": "Highlighted a backwards-compatibility risk the other models missed.",
"model": "anthropic/claude-sonnet-4.5"
}
]
} | +| `error` | *string* | ➖ | Error message when the fusion run did not produce an analysis result. | | +| `failedModels` | [models.FailedModel](../models/failedmodel.mdx)[] | ➖ | Models that were requested as part of the analysis panel but did not produce a response. Present when at least one requested analysis model failed. On a completed item the fusion result is still usable but was produced from a degraded panel; on a failed item it lists the panels that failed before the run stopped, so the caller can see which models were attempted even though no analysis was produced. | | +| `failureReason` | *string* | ➖ | Typed failure reason when the fusion run failed. Possible values include: all_panels_failed, insufficient_credits, rate_limited, invalid_model, judge_not_valid_json, judge_schema_mismatch, judge_upstream_error, judge_empty_completion. The four analysis-stage codes keep their pre-rename `judge_` spelling so existing consumers keep matching. The consumer-cancellation code is `cancelled`. | | +| `id` | *string* | ➖ | N/A | | +| `responses` | [models.OutputFusionServerToolItemResponse](../models/outputfusionservertoolitemresponse.mdx)[] | ➖ | Analysis models that produced a response in this fusion run, with each model's full panel content. | | +| `sources` | [models.FusionSource](../models/fusionsource.mdx)[] | ➖ | Web pages the analysis panels and analyst retrieved via web search during this fusion run, deduplicated by URL across the whole run. Present when at least one model cited a source. | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputFusionServerToolItemType](../models/outputfusionservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputfusionservertoolitemresponse.mdx b/docs/models/outputfusionservertoolitemresponse.mdx index ec84f788a..281c59edb 100644 --- a/docs/models/outputfusionservertoolitemresponse.mdx +++ b/docs/models/outputfusionservertoolitemresponse.mdx @@ -16,5 +16,5 @@ let value: OutputFusionServerToolItemResponse = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `content` | *string* | :heavy_minus_sign: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *string* | ➖ | N/A | +| `model` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputimagegenerationcallitem.mdx b/docs/models/outputimagegenerationcallitem.mdx index cc220ac92..5f4693bcf 100644 --- a/docs/models/outputimagegenerationcallitem.mdx +++ b/docs/models/outputimagegenerationcallitem.mdx @@ -18,8 +18,8 @@ let value: OutputImageGenerationCallItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `result` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ImageGenerationStatus](../models/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputImageGenerationCallItemType](../models/outputimagegenerationcallitemtype.mdx) | :heavy_check_mark: | N/A | | -| `prompt` | *string* | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file +| `id` | *string* | ✅ | N/A | | +| `result` | *string* | ➖ | N/A | | +| `status` | [models.ImageGenerationStatus](../models/imagegenerationstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputImageGenerationCallItemType](../models/outputimagegenerationcallitemtype.mdx) | ✅ | N/A | | +| `prompt` | *string* | ➖ | The prompt (possibly rewritten) that the image was generated from. | | \ No newline at end of file diff --git a/docs/models/outputimagegenerationservertoolitem.mdx b/docs/models/outputimagegenerationservertoolitem.mdx index 70161d9f0..7a1de8d88 100644 --- a/docs/models/outputimagegenerationservertoolitem.mdx +++ b/docs/models/outputimagegenerationservertoolitem.mdx @@ -19,11 +19,11 @@ let value: OutputImageGenerationServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `imageB64` | *string* | :heavy_minus_sign: | N/A | | -| `imageUrl` | *string* | :heavy_minus_sign: | N/A | | -| `prompt` | *string* | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | -| `result` | *string* | :heavy_minus_sign: | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | -| `revisedPrompt` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputImageGenerationServerToolItemType](../models/outputimagegenerationservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *string* | ➖ | N/A | | +| `imageB64` | *string* | ➖ | N/A | | +| `imageUrl` | *string* | ➖ | N/A | | +| `prompt` | *string* | ➖ | The prompt (possibly rewritten) that the image was generated from. | | +| `result` | *string* | ➖ | The generated image as a base64-encoded string or URL, matching OpenAI image_generation_call format | | +| `revisedPrompt` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputImageGenerationServerToolItemType](../models/outputimagegenerationservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputitemapplypatchcall.mdx b/docs/models/outputitemapplypatchcall.mdx index 973bdcbf8..c3d636ced 100644 --- a/docs/models/outputitemapplypatchcall.mdx +++ b/docs/models/outputitemapplypatchcall.mdx @@ -24,9 +24,9 @@ let value: OutputItemApplyPatchCall = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `callId` | *string* | :heavy_check_mark: | N/A | -| `createdBy` | *string* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `operation` | *models.Operation* | :heavy_check_mark: | N/A | -| `status` | [models.OutputItemApplyPatchCallStatus](../models/outputitemapplypatchcallstatus.mdx) | :heavy_check_mark: | N/A | -| `type` | *"apply_patch_call"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | +| `createdBy` | *string* | ➖ | N/A | +| `id` | *string* | ✅ | N/A | +| `operation` | *models.Operation* | ✅ | N/A | +| `status` | [models.OutputItemApplyPatchCallStatus](../models/outputitemapplypatchcallstatus.mdx) | ✅ | N/A | +| `type` | *"apply_patch_call"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputitemcodeinterpretercall.mdx b/docs/models/outputitemcodeinterpretercall.mdx index ffd2c0c38..62cee5d1f 100644 --- a/docs/models/outputitemcodeinterpretercall.mdx +++ b/docs/models/outputitemcodeinterpretercall.mdx @@ -18,10 +18,10 @@ let value: OutputItemCodeInterpreterCall = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `code` | *string* | :heavy_minus_sign: | N/A | | -| `containerId` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `outputs` | *models.OutputItemCodeInterpreterCallOutput*[] | :heavy_minus_sign: | N/A | | -| `status` | [models.OutputItemCodeInterpreterCallStatus](../models/outputitemcodeinterpretercallstatus.mdx) | :heavy_check_mark: | N/A | | -| `type` | *"code_interpreter_call"* | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"code": "print(\"hello\")",
"id": "ci_abc123",
"outputs": [
\{
"logs": "hello\n",
"type": "logs"
}
],
"status": "completed",
"type": "code_interpreter_call"
} | \ No newline at end of file +| `code` | *string* | ➖ | N/A | | +| `containerId` | *string* | ➖ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `outputs` | *models.OutputItemCodeInterpreterCallOutput*[] | ➖ | N/A | | +| `status` | [models.OutputItemCodeInterpreterCallStatus](../models/outputitemcodeinterpretercallstatus.mdx) | ✅ | N/A | | +| `type` | *"code_interpreter_call"* | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"code": "print(\"hello\")",
"id": "ci_abc123",
"outputs": [
\{
"logs": "hello\n",
"type": "logs"
}
],
"status": "completed",
"type": "code_interpreter_call"
} | \ No newline at end of file diff --git a/docs/models/outputitemcustomtoolcall.mdx b/docs/models/outputitemcustomtoolcall.mdx index e0b2866fb..cec719049 100644 --- a/docs/models/outputitemcustomtoolcall.mdx +++ b/docs/models/outputitemcustomtoolcall.mdx @@ -19,11 +19,11 @@ let value: OutputItemCustomToolCall = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `async` | *boolean* | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `input` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | [models.OutputItemCustomToolCallStatus](../models/outputitemcustomtoolcallstatus.mdx) | :heavy_minus_sign: | N/A | | -| `type` | *"custom_tool_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `async` | *boolean* | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `input` | *string* | ✅ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `namespace` | *string* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | [models.OutputItemCustomToolCallStatus](../models/outputitemcustomtoolcallstatus.mdx) | ➖ | N/A | | +| `type` | *"custom_tool_call"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputitemfilesearchcall.mdx b/docs/models/outputitemfilesearchcall.mdx index 71d50778a..ff18c9c3d 100644 --- a/docs/models/outputitemfilesearchcall.mdx +++ b/docs/models/outputitemfilesearchcall.mdx @@ -22,7 +22,7 @@ let value: OutputItemFileSearchCall = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `queries` | *string*[] | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | *"file_search_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *string* | ✅ | N/A | | +| `queries` | *string*[] | ✅ | N/A | | +| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | ✅ | N/A | completed | +| `type` | *"file_search_call"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputitemfunctioncall.mdx b/docs/models/outputitemfunctioncall.mdx index be0431e96..f85e54280 100644 --- a/docs/models/outputitemfunctioncall.mdx +++ b/docs/models/outputitemfunctioncall.mdx @@ -19,11 +19,11 @@ let value: OutputItemFunctionCall = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `async` | *boolean* | :heavy_minus_sign: | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `namespace` | *string* | :heavy_minus_sign: | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | -| `status` | *models.OutputItemFunctionCallStatusUnion* | :heavy_minus_sign: | N/A | | -| `type` | *"function_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | | +| `async` | *boolean* | ➖ | True when the model called a tool declared with `async: true` and may continue its turn before the output is returned. Return the result in a later request as a `function_call_output` with this `call_id`. | true | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `namespace` | *string* | ➖ | Namespace qualifier for tools registered as part of a namespace tool group (e.g. an MCP server) | | +| `status` | *models.OutputItemFunctionCallStatusUnion* | ➖ | N/A | | +| `type` | *"function_call"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputitemimagegenerationcall.mdx b/docs/models/outputitemimagegenerationcall.mdx index dc11fad5a..06f193d88 100644 --- a/docs/models/outputitemimagegenerationcall.mdx +++ b/docs/models/outputitemimagegenerationcall.mdx @@ -20,7 +20,7 @@ let value: OutputItemImageGenerationCall = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `result` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ImageGenerationStatus](../models/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | *"image_generation_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *string* | ✅ | N/A | | +| `result` | *string* | ➖ | N/A | | +| `status` | [models.ImageGenerationStatus](../models/imagegenerationstatus.mdx) | ✅ | N/A | completed | +| `type` | *"image_generation_call"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputitemreasoning.mdx b/docs/models/outputitemreasoning.mdx index 1781e76d5..7b72e838f 100644 --- a/docs/models/outputitemreasoning.mdx +++ b/docs/models/outputitemreasoning.mdx @@ -23,9 +23,9 @@ let value: OutputItemReasoning = { | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | :heavy_minus_sign: | N/A | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `status` | *models.OutputItemReasoningStatusUnion* | :heavy_minus_sign: | N/A | -| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | :heavy_check_mark: | N/A | -| `type` | *"reasoning"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | ➖ | N/A | +| `encryptedContent` | *string* | ➖ | N/A | +| `id` | *string* | ✅ | N/A | +| `status` | *models.OutputItemReasoningStatusUnion* | ➖ | N/A | +| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | ✅ | N/A | +| `type` | *"reasoning"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputitemwebsearchcall.mdx b/docs/models/outputitemwebsearchcall.mdx index f96d9d5fc..c578b8cdb 100644 --- a/docs/models/outputitemwebsearchcall.mdx +++ b/docs/models/outputitemwebsearchcall.mdx @@ -18,8 +18,8 @@ let value: OutputItemWebSearchCall = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `action` | *models.OutputItemWebSearchCallActionUnion* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | *"web_search_call"* | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"action": \{
"query": "OpenAI API",
"type": "search"
},
"id": "search-abc123",
"status": "completed",
"type": "web_search_call"
} | \ No newline at end of file +| `action` | *models.OutputItemWebSearchCallActionUnion* | ➖ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | ✅ | N/A | completed | +| `type` | *"web_search_call"* | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"action": \{
"query": "OpenAI API",
"type": "search"
},
"id": "search-abc123",
"status": "completed",
"type": "web_search_call"
} | \ No newline at end of file diff --git a/docs/models/outputitemwebsearchcallactionfindinpage.mdx b/docs/models/outputitemwebsearchcallactionfindinpage.mdx index b070ac44e..46ad47c13 100644 --- a/docs/models/outputitemwebsearchcallactionfindinpage.mdx +++ b/docs/models/outputitemwebsearchcallactionfindinpage.mdx @@ -18,6 +18,6 @@ let value: OutputItemWebSearchCallActionFindInPage = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `pattern` | *string* | :heavy_check_mark: | N/A | -| `type` | *"find_in_page"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `pattern` | *string* | ✅ | N/A | +| `type` | *"find_in_page"* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputitemwebsearchcallactionopenpage.mdx b/docs/models/outputitemwebsearchcallactionopenpage.mdx index 14debc6d8..814b79854 100644 --- a/docs/models/outputitemwebsearchcallactionopenpage.mdx +++ b/docs/models/outputitemwebsearchcallactionopenpage.mdx @@ -16,5 +16,5 @@ let value: OutputItemWebSearchCallActionOpenPage = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"open_page"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *"open_page"* | ✅ | N/A | +| `url` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/outputitemwebsearchcallactionsearch.mdx b/docs/models/outputitemwebsearchcallactionsearch.mdx index ade1a24b6..7e6c8583f 100644 --- a/docs/models/outputitemwebsearchcallactionsearch.mdx +++ b/docs/models/outputitemwebsearchcallactionsearch.mdx @@ -17,7 +17,7 @@ let value: OutputItemWebSearchCallActionSearch = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `queries` | *string*[] | :heavy_minus_sign: | N/A | -| `query` | *string* | :heavy_check_mark: | N/A | -| `sources` | [models.WebSearchSource](../models/websearchsource.mdx)[] | :heavy_minus_sign: | N/A | -| `type` | *"search"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `queries` | *string*[] | ➖ | N/A | +| `query` | *string* | ✅ | N/A | +| `sources` | [models.WebSearchSource](../models/websearchsource.mdx)[] | ➖ | N/A | +| `type` | *"search"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputmcpservertoolitem.mdx b/docs/models/outputmcpservertoolitem.mdx index 218dc8d2c..aa8c85cbd 100644 --- a/docs/models/outputmcpservertoolitem.mdx +++ b/docs/models/outputmcpservertoolitem.mdx @@ -19,8 +19,8 @@ let value: OutputMcpServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `serverLabel` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `toolName` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputMcpServerToolItemType](../models/outputmcpservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *string* | ➖ | N/A | | +| `serverLabel` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `toolName` | *string* | ➖ | N/A | | +| `type` | [models.OutputMcpServerToolItemType](../models/outputmcpservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputmemoryservertoolitem.mdx b/docs/models/outputmemoryservertoolitem.mdx index 376baf094..ffbdaea66 100644 --- a/docs/models/outputmemoryservertoolitem.mdx +++ b/docs/models/outputmemoryservertoolitem.mdx @@ -19,9 +19,9 @@ let value: OutputMemoryServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `action` | [models.ActionEnum](../models/actionenum.mdx) | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `key` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputMemoryServerToolItemType](../models/outputmemoryservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | -| `value` | *any* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `action` | [models.ActionEnum](../models/actionenum.mdx) | ➖ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `key` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputMemoryServerToolItemType](../models/outputmemoryservertoolitemtype.mdx) | ✅ | N/A | | +| `value` | *any* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/outputmessage.mdx b/docs/models/outputmessage.mdx index f76228e9a..d88f05633 100644 --- a/docs/models/outputmessage.mdx +++ b/docs/models/outputmessage.mdx @@ -24,9 +24,9 @@ let value: OutputMessage = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.OutputMessageContent*[] | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `phase` | *models.OutputMessagePhaseUnion* | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `role` | [models.OutputMessageRole](../models/outputmessagerole.mdx) | :heavy_check_mark: | N/A | -| `status` | *models.OutputMessageStatusUnion* | :heavy_minus_sign: | N/A | -| `type` | *"message"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *models.OutputMessageContent*[] | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `phase` | *models.OutputMessagePhaseUnion* | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | +| `role` | [models.OutputMessageRole](../models/outputmessagerole.mdx) | ✅ | N/A | +| `status` | *models.OutputMessageStatusUnion* | ➖ | N/A | +| `type` | *"message"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputmessageitem.mdx b/docs/models/outputmessageitem.mdx index a5fb774b4..29b04c5a3 100644 --- a/docs/models/outputmessageitem.mdx +++ b/docs/models/outputmessageitem.mdx @@ -26,9 +26,9 @@ let value: OutputMessageItem = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `content` | *models.OutputMessageItemContent*[] | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `phase` | *models.OutputMessageItemPhaseUnion* | :heavy_minus_sign: | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | -| `role` | [models.OutputMessageItemRole](../models/outputmessageitemrole.mdx) | :heavy_check_mark: | N/A | -| `status` | *models.OutputMessageItemStatusUnion* | :heavy_minus_sign: | N/A | -| `type` | *"message"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *models.OutputMessageItemContent*[] | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `phase` | *models.OutputMessageItemPhaseUnion* | ➖ | The phase of an assistant message. Use `commentary` for an intermediate assistant message and `final_answer` for the final assistant message. For follow-up requests with models like `gpt-5.3-codex` and later, preserve and resend phase on all assistant messages. Omitting it can degrade performance. Not used for user messages. | +| `role` | [models.OutputMessageItemRole](../models/outputmessageitemrole.mdx) | ✅ | N/A | +| `status` | *models.OutputMessageItemStatusUnion* | ➖ | N/A | +| `type` | *"message"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputreasoningitem.mdx b/docs/models/outputreasoningitem.mdx index 729c765fa..18167d0f2 100644 --- a/docs/models/outputreasoningitem.mdx +++ b/docs/models/outputreasoningitem.mdx @@ -25,11 +25,11 @@ let value: OutputReasoningItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | :heavy_minus_sign: | N/A | | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | *models.OutputReasoningItemStatusUnion* | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | :heavy_check_mark: | N/A | | -| `type` | *"reasoning"* | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *string* | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file +| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | ➖ | N/A | | +| `encryptedContent` | *string* | ➖ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `status` | *models.OutputReasoningItemStatusUnion* | ➖ | N/A | | +| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | ✅ | N/A | | +| `type` | *"reasoning"* | ✅ | N/A | | +| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | ➖ | N/A | unknown | +| `signature` | *string* | ➖ | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/outputsearchmodelsservertoolitem.mdx b/docs/models/outputsearchmodelsservertoolitem.mdx index ab3dc4110..81d4b0af9 100644 --- a/docs/models/outputsearchmodelsservertoolitem.mdx +++ b/docs/models/outputsearchmodelsservertoolitem.mdx @@ -19,8 +19,8 @@ let value: OutputSearchModelsServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `arguments` | *string* | :heavy_minus_sign: | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `query` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputSearchModelsServerToolItemType](../models/outputsearchmodelsservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *string* | ➖ | The JSON arguments submitted to the search tool (e.g. \{"query":"Claude"}) | | +| `id` | *string* | ➖ | N/A | | +| `query` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputSearchModelsServerToolItemType](../models/outputsearchmodelsservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputshellcallitem.mdx b/docs/models/outputshellcallitem.mdx index b311387d2..56ac97c37 100644 --- a/docs/models/outputshellcallitem.mdx +++ b/docs/models/outputshellcallitem.mdx @@ -21,9 +21,9 @@ let value: OutputShellCallItem = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [models.OutputShellCallItemAction](../models/outputshellcallitemaction.mdx) | :heavy_minus_sign: | N/A | | -| `arguments` | *string* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.ShellCallStatus](../models/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | -| `type` | *"shell_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [models.OutputShellCallItemAction](../models/outputshellcallitemaction.mdx) | ➖ | N/A | | +| `arguments` | *string* | ➖ | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | +| `callId` | *string* | ✅ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `status` | [models.ShellCallStatus](../models/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | +| `type` | *"shell_call"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputshellcallitemaction.mdx b/docs/models/outputshellcallitemaction.mdx index 588fe7dd9..41156e7b5 100644 --- a/docs/models/outputshellcallitemaction.mdx +++ b/docs/models/outputshellcallitemaction.mdx @@ -20,6 +20,6 @@ let value: OutputShellCallItemAction = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `commands` | *string*[] | :heavy_check_mark: | N/A | -| `maxOutputLength` | *number* | :heavy_check_mark: | N/A | -| `timeoutMs` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `commands` | *string*[] | ✅ | N/A | +| `maxOutputLength` | *number* | ✅ | N/A | +| `timeoutMs` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputshellcalloutputitem.mdx b/docs/models/outputshellcalloutputitem.mdx index ecd845a78..8513603ca 100644 --- a/docs/models/outputshellcalloutputitem.mdx +++ b/docs/models/outputshellcalloutputitem.mdx @@ -31,12 +31,12 @@ let value: OutputShellCallOutputItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `containerId` | *string* | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `error` | *string* | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'incomplete'` and an empty `output`; absent on a successful call. | | -| `files` | [models.OutputShellCallOutputItemFile](../models/outputshellcalloutputitemfile.mdx)[] | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `maxOutputLength` | *number* | :heavy_minus_sign: | N/A | | -| `output` | [models.ShellCallOutputContent](../models/shellcalloutputcontent.mdx)[] | :heavy_check_mark: | N/A | | -| `status` | [models.ShellCallStatus](../models/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | -| `type` | *"shell_call_output"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | | +| `containerId` | *string* | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `error` | *string* | ➖ | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'incomplete'` and an empty `output`; absent on a successful call. | | +| `files` | [models.OutputShellCallOutputItemFile](../models/outputshellcalloutputitemfile.mdx)[] | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `id` | *string* | ✅ | N/A | | +| `maxOutputLength` | *number* | ➖ | N/A | | +| `output` | [models.ShellCallOutputContent](../models/shellcalloutputcontent.mdx)[] | ✅ | N/A | | +| `status` | [models.ShellCallStatus](../models/shellcallstatus.mdx) | ✅ | Status of a shell call or its output. | completed | +| `type` | *"shell_call_output"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputshellcalloutputitemfile.mdx b/docs/models/outputshellcalloutputitemfile.mdx index c0ede95b4..60f1d7bba 100644 --- a/docs/models/outputshellcalloutputitemfile.mdx +++ b/docs/models/outputshellcalloutputitemfile.mdx @@ -21,9 +21,9 @@ let value: OutputShellCallOutputItemFile = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_check_mark: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.OutputShellCallOutputItemTypeContainerFileCitation](../models/outputshellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ✅ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `type` | [models.OutputShellCallOutputItemTypeContainerFileCitation](../models/outputshellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputshellservertoolitem.mdx b/docs/models/outputshellservertoolitem.mdx index 01e513205..3a9a24ebf 100644 --- a/docs/models/outputshellservertoolitem.mdx +++ b/docs/models/outputshellservertoolitem.mdx @@ -19,13 +19,13 @@ let value: OutputShellServerToolItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [models.OutputShellServerToolItemAction](../models/outputshellservertoolitemaction.mdx) | :heavy_minus_sign: | N/A | | -| `arguments` | *string* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. | | -| `callId` | *string* | :heavy_minus_sign: | The model-generated tool call id from the originating turn. | | -| `containerId` | *string* | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `error` | *string* | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. `output` is omitted when `error` is set. | | -| `files` | [models.OutputShellServerToolItemFile](../models/outputshellservertoolitemfile.mdx)[] | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `output` | [models.ShellCallOutputContent](../models/shellcalloutputcontent.mdx)[] | :heavy_minus_sign: | N/A | | -| `status` | [models.FailableToolCallStatus](../models/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputShellServerToolItemTypeOpenrouterShell](../models/outputshellservertoolitemtypeopenroutershell.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [models.OutputShellServerToolItemAction](../models/outputshellservertoolitemaction.mdx) | ➖ | N/A | | +| `arguments` | *string* | ➖ | The raw tool-call arguments string as emitted by the model. | | +| `callId` | *string* | ➖ | The model-generated tool call id from the originating turn. | | +| `containerId` | *string* | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `error` | *string* | ➖ | The error message when the sandbox call failed before producing a result (for example, the per-user container limit was reached). Set together with `status: 'failed'`; absent on a successful call. `output` is omitted when `error` is set. | | +| `files` | [models.OutputShellServerToolItemFile](../models/outputshellservertoolitemfile.mdx)[] | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `id` | *string* | ➖ | N/A | | +| `output` | [models.ShellCallOutputContent](../models/shellcalloutputcontent.mdx)[] | ➖ | N/A | | +| `status` | [models.FailableToolCallStatus](../models/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputShellServerToolItemTypeOpenrouterShell](../models/outputshellservertoolitemtypeopenroutershell.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputshellservertoolitemaction.mdx b/docs/models/outputshellservertoolitemaction.mdx index fd5a24185..5644da869 100644 --- a/docs/models/outputshellservertoolitemaction.mdx +++ b/docs/models/outputshellservertoolitemaction.mdx @@ -19,6 +19,6 @@ let value: OutputShellServerToolItemAction = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `commands` | *string*[] | :heavy_check_mark: | N/A | -| `maxOutputLength` | *number* | :heavy_minus_sign: | N/A | -| `timeoutMs` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `commands` | *string*[] | ✅ | N/A | +| `maxOutputLength` | *number* | ➖ | N/A | +| `timeoutMs` | *number* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/outputshellservertoolitemfile.mdx b/docs/models/outputshellservertoolitemfile.mdx index 3802d02e6..8d9a4c4ab 100644 --- a/docs/models/outputshellservertoolitemfile.mdx +++ b/docs/models/outputshellservertoolitemfile.mdx @@ -21,9 +21,9 @@ let value: OutputShellServerToolItemFile = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_check_mark: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.OutputShellServerToolItemTypeContainerFileCitation](../models/outputshellservertoolitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ✅ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `type` | [models.OutputShellServerToolItemTypeContainerFileCitation](../models/outputshellservertoolitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputsubagentservertoolitem.mdx b/docs/models/outputsubagentservertoolitem.mdx index e9d846803..4f262647c 100644 --- a/docs/models/outputsubagentservertoolitem.mdx +++ b/docs/models/outputsubagentservertoolitem.mdx @@ -19,14 +19,14 @@ let value: OutputSubagentServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. The `call_id` of the tool call that spawned this subagent. This id will also be included as the `subagent_id` on any `function_call` items created by the subagent. This must be returned in the request so the `function_call` can be matched with the correct subagent. A suspended `in_progress` item is announced once and never re-emitted or terminally closed — completion arrives as a new item with the same `call_id`. | | -| `error` | *string* | :heavy_minus_sign: | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `instanceName` | *string* | :heavy_minus_sign: | Provider-safe function name of the specific subagent instance that produced this item (e.g. `openrouter_subagent__1`). Present only on items from non-default instances — the second and later subagent entries in the request `tools` array. The first (default) instance omits it, even when multiple subagents are configured. When a replayed item echoes this field back, the transcript rehydrates the call under that instance's tool. This identity is positional: it is derived from the index of the subagent entry in the request `tools` array, so keep the order of subagent entries stable across requests in a conversation. | openrouter_subagent__1 | -| `model` | *string* | :heavy_minus_sign: | Slug of the worker model that executed the task. | | -| `name` | *string* | :heavy_minus_sign: | Configured name of the subagent that executed the task (the `name` on its tool entry). Present only for named subagents; omitted for an unnamed (default) subagent. | summarizer | -| `outcome` | *string* | :heavy_minus_sign: | The worker model's result (the outcome text returned to the delegating model). | | -| `status` | [models.FailableToolCallStatus](../models/failabletoolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `taskDescription` | *string* | :heavy_minus_sign: | The task description the delegating model sent to the worker. | | -| `taskName` | *string* | :heavy_minus_sign: | The short task identifier the delegating model supplied. | | -| `type` | [models.OutputSubagentServerToolItemType](../models/outputsubagentservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `callId` | *string* | ➖ | EXPERIMENTAL — subject to change without notice. The `call_id` of the tool call that spawned this subagent. This id will also be included as the `subagent_id` on any `function_call` items created by the subagent. This must be returned in the request so the `function_call` can be matched with the correct subagent. A suspended `in_progress` item is announced once and never re-emitted or terminally closed — completion arrives as a new item with the same `call_id`. | | +| `error` | *string* | ➖ | Error message when the subagent task did not produce an outcome. Set together with `status: 'failed'` on the terminal item. | | +| `id` | *string* | ➖ | N/A | | +| `instanceName` | *string* | ➖ | Provider-safe function name of the specific subagent instance that produced this item (e.g. `openrouter_subagent__1`). Present only on items from non-default instances — the second and later subagent entries in the request `tools` array. The first (default) instance omits it, even when multiple subagents are configured. When a replayed item echoes this field back, the transcript rehydrates the call under that instance's tool. This identity is positional: it is derived from the index of the subagent entry in the request `tools` array, so keep the order of subagent entries stable across requests in a conversation. | openrouter_subagent__1 | +| `model` | *string* | ➖ | Slug of the worker model that executed the task. | | +| `name` | *string* | ➖ | Configured name of the subagent that executed the task (the `name` on its tool entry). Present only for named subagents; omitted for an unnamed (default) subagent. | summarizer | +| `outcome` | *string* | ➖ | The worker model's result (the outcome text returned to the delegating model). | | +| `status` | [models.FailableToolCallStatus](../models/failabletoolcallstatus.mdx) | ✅ | N/A | completed | +| `taskDescription` | *string* | ➖ | The task description the delegating model sent to the worker. | | +| `taskName` | *string* | ➖ | The short task identifier the delegating model supplied. | | +| `type` | [models.OutputSubagentServerToolItemType](../models/outputsubagentservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputtexteditorservertoolitem.mdx b/docs/models/outputtexteditorservertoolitem.mdx index 9dc22d29e..124a4c592 100644 --- a/docs/models/outputtexteditorservertoolitem.mdx +++ b/docs/models/outputtexteditorservertoolitem.mdx @@ -19,8 +19,8 @@ let value: OutputTextEditorServerToolItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `command` | [models.Command](../models/command.mdx) | :heavy_minus_sign: | N/A | | -| `filePath` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputTextEditorServerToolItemType](../models/outputtexteditorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `command` | [models.Command](../models/command.mdx) | ➖ | N/A | | +| `filePath` | *string* | ➖ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputTextEditorServerToolItemType](../models/outputtexteditorservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputtokensdetails.mdx b/docs/models/outputtokensdetails.mdx index 8eac560f5..951280caf 100644 --- a/docs/models/outputtokensdetails.mdx +++ b/docs/models/outputtokensdetails.mdx @@ -16,4 +16,4 @@ let value: OutputTokensDetails = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `reasoningTokens` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `reasoningTokens` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputtoolsearchservertoolitem.mdx b/docs/models/outputtoolsearchservertoolitem.mdx index 0522241c2..92ce80798 100644 --- a/docs/models/outputtoolsearchservertoolitem.mdx +++ b/docs/models/outputtoolsearchservertoolitem.mdx @@ -19,7 +19,7 @@ let value: OutputToolSearchServerToolItem = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `query` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputToolSearchServerToolItemType](../models/outputtoolsearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `id` | *string* | ➖ | N/A | | +| `query` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputToolSearchServerToolItemType](../models/outputtoolsearchservertoolitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputwebfetchservertoolitem.mdx b/docs/models/outputwebfetchservertoolitem.mdx index 19d8cbd24..aa978358e 100644 --- a/docs/models/outputwebfetchservertoolitem.mdx +++ b/docs/models/outputwebfetchservertoolitem.mdx @@ -19,11 +19,11 @@ let value: OutputWebFetchServerToolItem = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `content` | *string* | :heavy_minus_sign: | N/A | | -| `error` | *string* | :heavy_minus_sign: | The error message if the fetch failed. | | -| `httpStatus` | *number* | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `title` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.OutputWebFetchServerToolItemType](../models/outputwebfetchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | -| `url` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `content` | *string* | ➖ | N/A | | +| `error` | *string* | ➖ | The error message if the fetch failed. | | +| `httpStatus` | *number* | ➖ | The HTTP status code returned by the upstream URL fetch. | | +| `id` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `title` | *string* | ➖ | N/A | | +| `type` | [models.OutputWebFetchServerToolItemType](../models/outputwebfetchservertoolitemtype.mdx) | ✅ | N/A | | +| `url` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/outputwebsearchcallitem.mdx b/docs/models/outputwebsearchcallitem.mdx index 37cc6cdb3..9ae70f521 100644 --- a/docs/models/outputwebsearchcallitem.mdx +++ b/docs/models/outputwebsearchcallitem.mdx @@ -18,8 +18,8 @@ let value: OutputWebSearchCallItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | *models.OutputWebSearchCallItemActionUnion* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputWebSearchCallItemTypeWebSearchCall](../models/outputwebsearchcallitemtypewebsearchcall.mdx) | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file +| `action` | *models.OutputWebSearchCallItemActionUnion* | ➖ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `status` | [models.WebSearchStatus](../models/websearchstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputWebSearchCallItemTypeWebSearchCall](../models/outputwebsearchcallitemtypewebsearchcall.mdx) | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | \ No newline at end of file diff --git a/docs/models/outputwebsearchcallitemactionfindinpage.mdx b/docs/models/outputwebsearchcallitemactionfindinpage.mdx index d7b03fc6d..1c12743d9 100644 --- a/docs/models/outputwebsearchcallitemactionfindinpage.mdx +++ b/docs/models/outputwebsearchcallitemactionfindinpage.mdx @@ -18,6 +18,6 @@ let value: OutputWebSearchCallItemActionFindInPage = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `pattern` | *string* | :heavy_check_mark: | N/A | -| `type` | *"find_in_page"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `pattern` | *string* | ✅ | N/A | +| `type` | *"find_in_page"* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputwebsearchcallitemactionopenpage.mdx b/docs/models/outputwebsearchcallitemactionopenpage.mdx index f0ff96951..5ef6155c4 100644 --- a/docs/models/outputwebsearchcallitemactionopenpage.mdx +++ b/docs/models/outputwebsearchcallitemactionopenpage.mdx @@ -16,5 +16,5 @@ let value: OutputWebSearchCallItemActionOpenPage = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"open_page"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `type` | *"open_page"* | ✅ | N/A | +| `url` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/outputwebsearchcallitemactionsearch.mdx b/docs/models/outputwebsearchcallitemactionsearch.mdx index ed08a139a..c7bbeae72 100644 --- a/docs/models/outputwebsearchcallitemactionsearch.mdx +++ b/docs/models/outputwebsearchcallitemactionsearch.mdx @@ -17,7 +17,7 @@ let value: OutputWebSearchCallItemActionSearch = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `queries` | *string*[] | :heavy_minus_sign: | N/A | -| `query` | *string* | :heavy_check_mark: | N/A | -| `sources` | [models.WebSearchSource](../models/websearchsource.mdx)[] | :heavy_minus_sign: | N/A | -| `type` | *"search"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `queries` | *string*[] | ➖ | N/A | +| `query` | *string* | ✅ | N/A | +| `sources` | [models.WebSearchSource](../models/websearchsource.mdx)[] | ➖ | N/A | +| `type` | *"search"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputwebsearchservertoolitem.mdx b/docs/models/outputwebsearchservertoolitem.mdx index 1d9d2aa3d..0dabf92d2 100644 --- a/docs/models/outputwebsearchservertoolitem.mdx +++ b/docs/models/outputwebsearchservertoolitem.mdx @@ -19,7 +19,7 @@ let value: OutputWebSearchServerToolItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `action` | [models.OutputWebSearchServerToolItemAction](../models/outputwebsearchservertoolitemaction.mdx) | :heavy_minus_sign: | The search action performed, matching OpenAI web_search_call.action shape. Includes the query the model issued and optional source URLs returned by the search provider. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `type` | [models.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../models/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [models.OutputWebSearchServerToolItemAction](../models/outputwebsearchservertoolitemaction.mdx) | ➖ | The search action performed, matching OpenAI web_search_call.action shape. Includes the query the model issued and optional source URLs returned by the search provider. | | +| `id` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ✅ | N/A | completed | +| `type` | [models.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../models/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/outputwebsearchservertoolitemaction.mdx b/docs/models/outputwebsearchservertoolitemaction.mdx index 9cbee2778..6d2551cae 100644 --- a/docs/models/outputwebsearchservertoolitemaction.mdx +++ b/docs/models/outputwebsearchservertoolitemaction.mdx @@ -19,6 +19,6 @@ let value: OutputWebSearchServerToolItemAction = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `query` | *string* | :heavy_check_mark: | N/A | -| `sources` | [models.OutputWebSearchServerToolItemSource](../models/outputwebsearchservertoolitemsource.mdx)[] | :heavy_minus_sign: | N/A | -| `type` | [models.OutputWebSearchServerToolItemTypeSearch](../models/outputwebsearchservertoolitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `query` | *string* | ✅ | N/A | +| `sources` | [models.OutputWebSearchServerToolItemSource](../models/outputwebsearchservertoolitemsource.mdx)[] | ➖ | N/A | +| `type` | [models.OutputWebSearchServerToolItemTypeSearch](../models/outputwebsearchservertoolitemtypesearch.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/outputwebsearchservertoolitemsource.mdx b/docs/models/outputwebsearchservertoolitemsource.mdx index cb965d4cd..846e21658 100644 --- a/docs/models/outputwebsearchservertoolitemsource.mdx +++ b/docs/models/outputwebsearchservertoolitemsource.mdx @@ -17,5 +17,5 @@ let value: OutputWebSearchServerToolItemSource = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `type` | [models.OutputWebSearchServerToolItemTypeURL](../models/outputwebsearchservertoolitemtypeurl.mdx) | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.OutputWebSearchServerToolItemTypeURL](../models/outputwebsearchservertoolitemtypeurl.mdx) | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/paretorouterplugin.mdx b/docs/models/paretorouterplugin.mdx index 187b6db90..d522b00ba 100644 --- a/docs/models/paretorouterplugin.mdx +++ b/docs/models/paretorouterplugin.mdx @@ -16,8 +16,8 @@ let value: ParetoRouterPlugin = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | -| `id` | *"pareto-router"* | :heavy_check_mark: | N/A | | -| `maxPrice` | *number* | :heavy_minus_sign: | Maximum input price in USD per million tokens. When set, quality-tier selection (min_coding_score) is bypassed: the router computes the Pareto frontier over the top coding models and routes to the best-scoring frontier model priced at or below this cap, falling back through cheaper frontier models, then non-frontier models. Enforced against the price source given by price_source. Returns 404 when no candidate satisfies the cap. | 5 | -| `minCodingScore` | *number* | :heavy_minus_sign: | Minimum coding quality score between 0 and 1. Maps to internal quality tiers: >= 0.66 → high (top coding models), >= 0.33 → medium (strong modern flagships), < 0.33 → low (capable coders above the median). Omit to default to the highest tier (equivalent to >= 0.66). Not used when max_price is set (price-based selection takes over). | 0.8 | -| `priceSource` | [models.PriceSource](../models/pricesource.mdx) | :heavy_minus_sign: | Price source for the Pareto frontier cost axis and for enforcing max_price. "prompt" uses catalog list price (endpoint.pricing.prompt). "weighted_avg" uses traffic-weighted effective input price from ClickHouse, falling back to prompt price for models without traffic data. Defaults to "prompt". | | \ No newline at end of file +| `enabled` | *boolean* | ➖ | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | +| `id` | *"pareto-router"* | ✅ | N/A | | +| `maxPrice` | *number* | ➖ | Maximum input price in USD per million tokens. When set, quality-tier selection (min_coding_score) is bypassed: the router computes the Pareto frontier over the top coding models and routes to the best-scoring frontier model priced at or below this cap, falling back through cheaper frontier models, then non-frontier models. Enforced against the price source given by price_source. Returns 404 when no candidate satisfies the cap. | 5 | +| `minCodingScore` | *number* | ➖ | Minimum coding quality score between 0 and 1. Maps to internal quality tiers: >= 0.66 → high (top coding models), >= 0.33 → medium (strong modern flagships), < 0.33 → low (capable coders above the median). Omit to default to the highest tier (equivalent to >= 0.66). Not used when max_price is set (price-based selection takes over). | 0.8 | +| `priceSource` | [models.PriceSource](../models/pricesource.mdx) | ➖ | Price source for the Pareto frontier cost axis and for enforcing max_price. "prompt" uses catalog list price (endpoint.pricing.prompt). "weighted_avg" uses traffic-weighted effective input price from ClickHouse, falling back to prompt price for models without traffic data. Defaults to "prompt". | | \ No newline at end of file diff --git a/docs/models/partialcoverage.mdx b/docs/models/partialcoverage.mdx index 2bcf7fed8..0ce3a6669 100644 --- a/docs/models/partialcoverage.mdx +++ b/docs/models/partialcoverage.mdx @@ -17,5 +17,5 @@ let value: PartialCoverage = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `models` | *string*[] | :heavy_check_mark: | N/A | -| `point` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `models` | *string*[] | ✅ | N/A | +| `point` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/payloadtoolargeresponseerrordata.mdx b/docs/models/payloadtoolargeresponseerrordata.mdx index 2b48515ca..0236d764b 100644 --- a/docs/models/payloadtoolargeresponseerrordata.mdx +++ b/docs/models/payloadtoolargeresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: PayloadTooLargeResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/paymentrequiredresponseerrordata.mdx b/docs/models/paymentrequiredresponseerrordata.mdx index 007bef103..12eb0d59e 100644 --- a/docs/models/paymentrequiredresponseerrordata.mdx +++ b/docs/models/paymentrequiredresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: PaymentRequiredResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/pdfparseroptions.mdx b/docs/models/pdfparseroptions.mdx index e2eef08ab..9b3e19e03 100644 --- a/docs/models/pdfparseroptions.mdx +++ b/docs/models/pdfparseroptions.mdx @@ -16,4 +16,4 @@ let value: PDFParserOptions = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `engine` | *models.PDFParserEngine* | :heavy_minus_sign: | The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". | cloudflare-ai | \ No newline at end of file +| `engine` | *models.PDFParserEngine* | ➖ | The engine to use for parsing PDF files. "pdf-text" is deprecated and automatically redirected to "cloudflare-ai". | cloudflare-ai | \ No newline at end of file diff --git a/docs/models/pendingsafetycheck.mdx b/docs/models/pendingsafetycheck.mdx index 9ddc1d1b6..32f8b1baa 100644 --- a/docs/models/pendingsafetycheck.mdx +++ b/docs/models/pendingsafetycheck.mdx @@ -18,6 +18,6 @@ let value: PendingSafetyCheck = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `code` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `code` | *string* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/percentilelatencycutoffs.mdx b/docs/models/percentilelatencycutoffs.mdx index 9f0708e26..7ebaf7855 100644 --- a/docs/models/percentilelatencycutoffs.mdx +++ b/docs/models/percentilelatencycutoffs.mdx @@ -16,7 +16,7 @@ let value: PercentileLatencyCutoffs = {}; | Field | Type | Required | Description | | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | -| `p50` | *number* | :heavy_minus_sign: | Maximum p50 latency (seconds) | -| `p75` | *number* | :heavy_minus_sign: | Maximum p75 latency (seconds) | -| `p90` | *number* | :heavy_minus_sign: | Maximum p90 latency (seconds) | -| `p99` | *number* | :heavy_minus_sign: | Maximum p99 latency (seconds) | \ No newline at end of file +| `p50` | *number* | ➖ | Maximum p50 latency (seconds) | +| `p75` | *number* | ➖ | Maximum p75 latency (seconds) | +| `p90` | *number* | ➖ | Maximum p90 latency (seconds) | +| `p99` | *number* | ➖ | Maximum p99 latency (seconds) | \ No newline at end of file diff --git a/docs/models/percentilestats.mdx b/docs/models/percentilestats.mdx index f941ee288..014e573a5 100644 --- a/docs/models/percentilestats.mdx +++ b/docs/models/percentilestats.mdx @@ -21,7 +21,7 @@ let value: PercentileStats = { | Field | Type | Required | Description | Example | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `p50` | *number* | :heavy_check_mark: | Median (50th percentile) | 25.5 | -| `p75` | *number* | :heavy_check_mark: | 75th percentile | 35.2 | -| `p90` | *number* | :heavy_check_mark: | 90th percentile | 48.7 | -| `p99` | *number* | :heavy_check_mark: | 99th percentile | 85.3 | \ No newline at end of file +| `p50` | *number* | ✅ | Median (50th percentile) | 25.5 | +| `p75` | *number* | ✅ | 75th percentile | 35.2 | +| `p90` | *number* | ✅ | 90th percentile | 48.7 | +| `p99` | *number* | ✅ | 99th percentile | 85.3 | \ No newline at end of file diff --git a/docs/models/percentilethroughputcutoffs.mdx b/docs/models/percentilethroughputcutoffs.mdx index 22ccc37a8..619532062 100644 --- a/docs/models/percentilethroughputcutoffs.mdx +++ b/docs/models/percentilethroughputcutoffs.mdx @@ -16,7 +16,7 @@ let value: PercentileThroughputCutoffs = {}; | Field | Type | Required | Description | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `p50` | *number* | :heavy_minus_sign: | Minimum p50 throughput (tokens/sec) | -| `p75` | *number* | :heavy_minus_sign: | Minimum p75 throughput (tokens/sec) | -| `p90` | *number* | :heavy_minus_sign: | Minimum p90 throughput (tokens/sec) | -| `p99` | *number* | :heavy_minus_sign: | Minimum p99 throughput (tokens/sec) | \ No newline at end of file +| `p50` | *number* | ➖ | Minimum p50 throughput (tokens/sec) | +| `p75` | *number* | ➖ | Minimum p75 throughput (tokens/sec) | +| `p90` | *number* | ➖ | Minimum p90 throughput (tokens/sec) | +| `p99` | *number* | ➖ | Minimum p99 throughput (tokens/sec) | \ No newline at end of file diff --git a/docs/models/perflast30mbyworkload.mdx b/docs/models/perflast30mbyworkload.mdx index db4b973e1..5e9bb0a1c 100644 --- a/docs/models/perflast30mbyworkload.mdx +++ b/docs/models/perflast30mbyworkload.mdx @@ -16,12 +16,12 @@ let value: PerfLast30mByWorkload = {}; | Field | Type | Required | Description | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `decisions` | [models.Decisions](../models/decisions.mdx) | :heavy_minus_sign: | N/A | -| `embeddings` | [models.Embeddings](../models/embeddings.mdx) | :heavy_minus_sign: | N/A | -| `imageGeneration` | [models.ImageGeneration](../models/imagegeneration.mdx) | :heavy_minus_sign: | N/A | -| `rerank` | [models.Rerank](../models/rerank.mdx) | :heavy_minus_sign: | N/A | -| `stt` | [models.STT](../models/stt.mdx) | :heavy_minus_sign: | N/A | -| `textGeneration` | [models.TextGeneration](../models/textgeneration.mdx) | :heavy_minus_sign: | N/A | -| `tts` | [models.TTS](../models/tts.mdx) | :heavy_minus_sign: | N/A | -| `unknown` | [models.Unknown](../models/unknown.mdx) | :heavy_minus_sign: | N/A | -| `videoGeneration` | [models.VideoGeneration](../models/videogeneration.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `decisions` | [models.Decisions](../models/decisions.mdx) | ➖ | N/A | +| `embeddings` | [models.Embeddings](../models/embeddings.mdx) | ➖ | N/A | +| `imageGeneration` | [models.ImageGeneration](../models/imagegeneration.mdx) | ➖ | N/A | +| `rerank` | [models.Rerank](../models/rerank.mdx) | ➖ | N/A | +| `stt` | [models.STT](../models/stt.mdx) | ➖ | N/A | +| `textGeneration` | [models.TextGeneration](../models/textgeneration.mdx) | ➖ | N/A | +| `tts` | [models.TTS](../models/tts.mdx) | ➖ | N/A | +| `unknown` | [models.Unknown](../models/unknown.mdx) | ➖ | N/A | +| `videoGeneration` | [models.VideoGeneration](../models/videogeneration.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/perrequestlimits.mdx b/docs/models/perrequestlimits.mdx index 532da4a5a..7231b55b8 100644 --- a/docs/models/perrequestlimits.mdx +++ b/docs/models/perrequestlimits.mdx @@ -19,5 +19,5 @@ let value: PerRequestLimits = { | Field | Type | Required | Description | Example | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `completionTokens` | *number* | :heavy_check_mark: | Maximum completion tokens per request | 1000 | -| `promptTokens` | *number* | :heavy_check_mark: | Maximum prompt tokens per request | 1000 | \ No newline at end of file +| `completionTokens` | *number* | ✅ | Maximum completion tokens per request | 1000 | +| `promptTokens` | *number* | ✅ | Maximum prompt tokens per request | 1000 | \ No newline at end of file diff --git a/docs/models/pipelinestage.mdx b/docs/models/pipelinestage.mdx index a445758be..aa2d8e72d 100644 --- a/docs/models/pipelinestage.mdx +++ b/docs/models/pipelinestage.mdx @@ -17,10 +17,10 @@ let value: PipelineStage = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `costUsd` | *number* | :heavy_minus_sign: | N/A | | -| `data` | Record\ | :heavy_minus_sign: | N/A | | -| `guardrailId` | *string* | :heavy_minus_sign: | N/A | | -| `guardrailScope` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `summary` | *string* | :heavy_minus_sign: | N/A | | -| `type` | [models.PipelineStageType](../models/pipelinestagetype.mdx) | :heavy_check_mark: | Categorical kind of a pipeline stage. Multiple plugins can share a type (e.g. all guardrail-level plugins emit `guardrail`); the `name` field disambiguates which plugin emitted it. | guardrail | \ No newline at end of file +| `costUsd` | *number* | ➖ | N/A | | +| `data` | Record\ | ➖ | N/A | | +| `guardrailId` | *string* | ➖ | N/A | | +| `guardrailScope` | *string* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `summary` | *string* | ➖ | N/A | | +| `type` | [models.PipelineStageType](../models/pipelinestagetype.mdx) | ✅ | Categorical kind of a pipeline stage. Multiple plugins can share a type (e.g. all guardrail-level plugins emit `guardrail`); the `name` field disambiguates which plugin emitted it. | guardrail | \ No newline at end of file diff --git a/docs/models/prediction.mdx b/docs/models/prediction.mdx index e88206524..08fbb379e 100644 --- a/docs/models/prediction.mdx +++ b/docs/models/prediction.mdx @@ -19,5 +19,5 @@ let value: Prediction = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `content` | *models.PredictionContent* | :heavy_check_mark: | N/A | -| `type` | [models.PredictionType](../models/predictiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *models.PredictionContent* | ✅ | N/A | +| `type` | [models.PredictionType](../models/predictiontype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/predictioncontenttext.mdx b/docs/models/predictioncontenttext.mdx index e8f4063eb..48a08601d 100644 --- a/docs/models/predictioncontenttext.mdx +++ b/docs/models/predictioncontenttext.mdx @@ -19,5 +19,5 @@ let value: PredictionContentText = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.PredictionContentTextType](../models/predictioncontenttexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *string* | ✅ | N/A | +| `type` | [models.PredictionContentTextType](../models/predictioncontenttexttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/preset.mdx b/docs/models/preset.mdx index 2f2c0a080..f3cffc175 100644 --- a/docs/models/preset.mdx +++ b/docs/models/preset.mdx @@ -28,14 +28,14 @@ let value: Preset = { | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `createdAt` | *string* | :heavy_check_mark: | N/A | | -| `creatorUserId` | *string* | :heavy_check_mark: | N/A | | -| `description` | *string* | :heavy_check_mark: | N/A | | -| `designatedVersionId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `slug` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.PresetStatus](../models/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | -| `statusUpdatedAt` | *string* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | N/A | | -| `workspaceId` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `createdAt` | *string* | ✅ | N/A | | +| `creatorUserId` | *string* | ✅ | N/A | | +| `description` | *string* | ✅ | N/A | | +| `designatedVersionId` | *string* | ✅ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `slug` | *string* | ✅ | N/A | | +| `status` | [models.PresetStatus](../models/presetstatus.mdx) | ✅ | The status of a preset. | active | +| `statusUpdatedAt` | *string* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | N/A | | +| `workspaceId` | *string* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/presetdesignatedversion.mdx b/docs/models/presetdesignatedversion.mdx index 516f2a1c8..52514fd17 100644 --- a/docs/models/presetdesignatedversion.mdx +++ b/docs/models/presetdesignatedversion.mdx @@ -28,11 +28,11 @@ let value: PresetDesignatedVersion = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `config` | Record\ | :heavy_check_mark: | N/A | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `creatorId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `presetId` | *string* | :heavy_check_mark: | N/A | -| `systemPrompt` | *string* | :heavy_check_mark: | N/A | -| `updatedAt` | *string* | :heavy_check_mark: | N/A | -| `version` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `config` | Record\ | ✅ | N/A | +| `createdAt` | *string* | ✅ | N/A | +| `creatorId` | *string* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `presetId` | *string* | ✅ | N/A | +| `systemPrompt` | *string* | ✅ | N/A | +| `updatedAt` | *string* | ✅ | N/A | +| `version` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/presetwithdesignatedversion.mdx b/docs/models/presetwithdesignatedversion.mdx index 2e284a7ad..582e019d2 100644 --- a/docs/models/presetwithdesignatedversion.mdx +++ b/docs/models/presetwithdesignatedversion.mdx @@ -41,15 +41,15 @@ let value: PresetWithDesignatedVersion = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | *string* | :heavy_check_mark: | N/A | | -| `creatorUserId` | *string* | :heavy_check_mark: | N/A | | -| `description` | *string* | :heavy_check_mark: | N/A | | -| `designatedVersionId` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `slug` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.PresetStatus](../models/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | -| `statusUpdatedAt` | *string* | :heavy_check_mark: | N/A | | -| `updatedAt` | *string* | :heavy_check_mark: | N/A | | -| `workspaceId` | *string* | :heavy_check_mark: | N/A | | -| `designatedVersion` | [models.PresetDesignatedVersion](../models/presetdesignatedversion.mdx) | :heavy_check_mark: | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file +| `createdAt` | *string* | ✅ | N/A | | +| `creatorUserId` | *string* | ✅ | N/A | | +| `description` | *string* | ✅ | N/A | | +| `designatedVersionId` | *string* | ✅ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `slug` | *string* | ✅ | N/A | | +| `status` | [models.PresetStatus](../models/presetstatus.mdx) | ✅ | The status of a preset. | active | +| `statusUpdatedAt` | *string* | ✅ | N/A | | +| `updatedAt` | *string* | ✅ | N/A | | +| `workspaceId` | *string* | ✅ | N/A | | +| `designatedVersion` | [models.PresetDesignatedVersion](../models/presetdesignatedversion.mdx) | ✅ | A specific version of a preset, containing config and optional system prompt. | \{
"config": \{
"model": "openai/gpt-4o",
"temperature": 0.7
},
"created_at": "2026-04-20T10:00:00Z",
"creator_id": "user_2dHFtVWx2n56w6HkM0000000000",
"id": "550e8400-e29b-41d4-a716-446655440000",
"preset_id": "650e8400-e29b-41d4-a716-446655440001",
"system_prompt": "You are a helpful assistant.",
"updated_at": "2026-04-20T10:00:00Z",
"version": 1
} | \ No newline at end of file diff --git a/docs/models/preview20250311websearchservertool.mdx b/docs/models/preview20250311websearchservertool.mdx index af611342b..be0b600af 100644 --- a/docs/models/preview20250311websearchservertool.mdx +++ b/docs/models/preview20250311websearchservertool.mdx @@ -18,12 +18,12 @@ let value: Preview20250311WebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `filters` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [models.Preview20250311WebSearchServerToolType](../models/preview20250311websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.PreviewWebSearchUserLocation](../models/previewwebsearchuserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `filters` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `maxResults` | *number* | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `maxUses` | *number* | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `type` | [models.Preview20250311WebSearchServerToolType](../models/preview20250311websearchservertooltype.mdx) | ✅ | N/A | | +| `userLocation` | [models.PreviewWebSearchUserLocation](../models/previewwebsearchuserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/previewwebsearchservertool.mdx b/docs/models/previewwebsearchservertool.mdx index 5e5a13431..e342bfb34 100644 --- a/docs/models/previewwebsearchservertool.mdx +++ b/docs/models/previewwebsearchservertool.mdx @@ -18,12 +18,12 @@ let value: PreviewWebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `filters` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [models.PreviewWebSearchServerToolType](../models/previewwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.PreviewWebSearchUserLocation](../models/previewwebsearchuserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `filters` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `maxResults` | *number* | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `maxUses` | *number* | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `type` | [models.PreviewWebSearchServerToolType](../models/previewwebsearchservertooltype.mdx) | ✅ | N/A | | +| `userLocation` | [models.PreviewWebSearchUserLocation](../models/previewwebsearchuserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/previewwebsearchuserlocation.mdx b/docs/models/previewwebsearchuserlocation.mdx index 6c0c7eeb6..f90b98259 100644 --- a/docs/models/previewwebsearchuserlocation.mdx +++ b/docs/models/previewwebsearchuserlocation.mdx @@ -16,8 +16,8 @@ let value: PreviewWebSearchUserLocation = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.PreviewWebSearchUserLocationType](../models/previewwebsearchuserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `city` | *string* | ➖ | N/A | +| `country` | *string* | ➖ | N/A | +| `region` | *string* | ➖ | N/A | +| `timezone` | *string* | ➖ | N/A | +| `type` | [models.PreviewWebSearchUserLocationType](../models/previewwebsearchuserlocationtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/pricing.mdx b/docs/models/pricing.mdx index 8b3f039a3..2ca45b967 100644 --- a/docs/models/pricing.mdx +++ b/docs/models/pricing.mdx @@ -17,19 +17,19 @@ let value: Pricing = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `audio` | *string* | :heavy_minus_sign: | Price in USD per audio input token | -| `audioOutput` | *string* | :heavy_minus_sign: | Price in USD per audio output token | -| `completion` | *string* | :heavy_check_mark: | Price in USD per token for completion (output) generation | -| `discount` | *number* | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `image` | *string* | :heavy_minus_sign: | Price in USD per input image | -| `imageOutput` | *string* | :heavy_minus_sign: | Price in USD per output image | -| `imageToken` | *string* | :heavy_minus_sign: | Price in USD per image token | -| `inputAudioCache` | *string* | :heavy_minus_sign: | Price in USD per cached audio input token | -| `inputCacheRead` | *string* | :heavy_minus_sign: | Price in USD per cached input token (read) | -| `inputCacheWrite` | *string* | :heavy_minus_sign: | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | -| `inputCacheWrite1h` | *string* | :heavy_minus_sign: | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | -| `internalReasoning` | *string* | :heavy_minus_sign: | Price in USD per internal reasoning token | -| `overrides` | [models.PricingOverride](../models/pricingoverride.mdx)[] | :heavy_minus_sign: | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | -| `prompt` | *string* | :heavy_check_mark: | Price in USD per token for prompt (input) processing | -| `request` | *string* | :heavy_minus_sign: | Price in USD per request | -| `webSearch` | *string* | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file +| `audio` | *string* | ➖ | Price in USD per audio input token | +| `audioOutput` | *string* | ➖ | Price in USD per audio output token | +| `completion` | *string* | ✅ | Price in USD per token for completion (output) generation | +| `discount` | *number* | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `image` | *string* | ➖ | Price in USD per input image | +| `imageOutput` | *string* | ➖ | Price in USD per output image | +| `imageToken` | *string* | ➖ | Price in USD per image token | +| `inputAudioCache` | *string* | ➖ | Price in USD per cached audio input token | +| `inputCacheRead` | *string* | ➖ | Price in USD per cached input token (read) | +| `inputCacheWrite` | *string* | ➖ | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | +| `inputCacheWrite1h` | *string* | ➖ | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | +| `internalReasoning` | *string* | ➖ | Price in USD per internal reasoning token | +| `overrides` | [models.PricingOverride](../models/pricingoverride.mdx)[] | ➖ | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | +| `prompt` | *string* | ✅ | Price in USD per token for prompt (input) processing | +| `request` | *string* | ➖ | Price in USD per request | +| `webSearch` | *string* | ➖ | Price in USD per web search | \ No newline at end of file diff --git a/docs/models/pricingoverride.mdx b/docs/models/pricingoverride.mdx index 8ff6de441..8df559a4e 100644 --- a/docs/models/pricingoverride.mdx +++ b/docs/models/pricingoverride.mdx @@ -16,14 +16,14 @@ let value: PricingOverride = {}; | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `audio` | *string* | :heavy_minus_sign: | Overridden price in USD per audio input token | -| `completion` | *string* | :heavy_minus_sign: | Overridden price in USD per token for completion (output) generation | -| `inputAudioCache` | *string* | :heavy_minus_sign: | Overridden price in USD per cached audio input token | -| `inputCacheRead` | *string* | :heavy_minus_sign: | Overridden price in USD per cached input token (read) | -| `inputCacheWrite` | *string* | :heavy_minus_sign: | Overridden price in USD per cache-write token | -| `inputCacheWrite1h` | *string* | :heavy_minus_sign: | Overridden price in USD per 1-hour cache-write token | -| `minPromptTokens` | *number* | :heavy_minus_sign: | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | -| `prompt` | *string* | :heavy_minus_sign: | Overridden price in USD per token for prompt (input) processing | -| `utcDays` | [models.UtcDay](../models/utcday.mdx)[] | :heavy_minus_sign: | Condition: UTC weekdays the entry applies on, evaluated at the request instant. Scopes the utc_start/utc_end window (or, without a window, the whole UTC day) to the listed days. Absent means every day. | -| `utcEnd` | *number* | :heavy_minus_sign: | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | -| `utcStart` | *number* | :heavy_minus_sign: | Condition: inclusive start of a daily UTC time window as an HHMM clock number (e.g. 100 = 01:00, 1030 = 10:30). The entry applies while the current UTC time is inside the half-open window [utc_start, utc_end), which may wrap past midnight (utc_start > utc_end). | \ No newline at end of file +| `audio` | *string* | ➖ | Overridden price in USD per audio input token | +| `completion` | *string* | ➖ | Overridden price in USD per token for completion (output) generation | +| `inputAudioCache` | *string* | ➖ | Overridden price in USD per cached audio input token | +| `inputCacheRead` | *string* | ➖ | Overridden price in USD per cached input token (read) | +| `inputCacheWrite` | *string* | ➖ | Overridden price in USD per cache-write token | +| `inputCacheWrite1h` | *string* | ➖ | Overridden price in USD per 1-hour cache-write token | +| `minPromptTokens` | *number* | ➖ | Condition: the entry applies when the total prompt tokens of a request are strictly greater than this threshold | +| `prompt` | *string* | ➖ | Overridden price in USD per token for prompt (input) processing | +| `utcDays` | [models.UtcDay](../models/utcday.mdx)[] | ➖ | Condition: UTC weekdays the entry applies on, evaluated at the request instant. Scopes the utc_start/utc_end window (or, without a window, the whole UTC day) to the listed days. Absent means every day. | +| `utcEnd` | *number* | ➖ | Condition: exclusive end of a daily UTC time window as an HHMM clock number (e.g. 400 = 04:00) | +| `utcStart` | *number* | ➖ | Condition: inclusive start of a daily UTC time window as an HHMM clock number (e.g. 100 = 01:00, 1030 = 10:30). The entry applies while the current UTC time is inside the half-open window [utc_start, utc_end), which may wrap past midnight (utc_start > utc_end). | \ No newline at end of file diff --git a/docs/models/privateendpoint.mdx b/docs/models/privateendpoint.mdx index 8c4bebf67..b17ababeb 100644 --- a/docs/models/privateendpoint.mdx +++ b/docs/models/privateendpoint.mdx @@ -30,15 +30,15 @@ let value: PrivateEndpoint = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `baseUrl` | *string* | :heavy_check_mark: | HTTPS base URL of your deployment, or `null` for providers whose URL is derived from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | -| `declaredRegion` | [models.PrivateEndpointDeclaredRegion](../models/privateendpointdeclaredregion.mdx) | :heavy_check_mark: | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | -| `declaredZdr` | *boolean* | :heavy_check_mark: | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `modelName` | *string* | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `modelPermaslug` | *string* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `modelSlug` | *string* | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `pricing` | [models.PrivateEndpointPricing](../models/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | -| `providerName` | *string* | :heavy_check_mark: | Display name of the upstream provider. | Azure | -| `providerSlug` | *string* | :heavy_check_mark: | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | -| `status` | [models.PrivateEndpointStatus](../models/privateendpointstatus.mdx) | :heavy_check_mark: | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | -| `upstreamModelId` | *string* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `baseUrl` | *string* | ✅ | HTTPS base URL of your deployment, or `null` for providers whose URL is derived from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | +| `declaredRegion` | [models.PrivateEndpointDeclaredRegion](../models/privateendpointdeclaredregion.mdx) | ✅ | Where you attest this deployment processes data. `global` means not regional; `null` means undeclared. | us | +| `declaredZdr` | *boolean* | ✅ | Whether you attest this deployment retains no prompt or completion data. `null` means undeclared. | true | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `modelName` | *string* | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `modelPermaslug` | *string* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `modelSlug` | *string* | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `pricing` | [models.PrivateEndpointPricing](../models/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | +| `providerName` | *string* | ✅ | Display name of the upstream provider. | Azure | +| `providerSlug` | *string* | ✅ | Slug of the upstream provider, or `null` when the provider is no longer listed. | azure | +| `status` | [models.PrivateEndpointStatus](../models/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | +| `upstreamModelId` | *string* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/models/privateendpointactivation.mdx b/docs/models/privateendpointactivation.mdx index 825fd3da2..a362f5a40 100644 --- a/docs/models/privateendpointactivation.mdx +++ b/docs/models/privateendpointactivation.mdx @@ -18,4 +18,4 @@ let value: PrivateEndpointActivation = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `workspaceId` | *string* | :heavy_check_mark: | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `workspaceId` | *string* | ✅ | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/privateendpointcheck.mdx b/docs/models/privateendpointcheck.mdx index c30272a74..0326e086f 100644 --- a/docs/models/privateendpointcheck.mdx +++ b/docs/models/privateendpointcheck.mdx @@ -17,9 +17,9 @@ let value: PrivateEndpointCheck = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `actualModel` | *string* | :heavy_minus_sign: | Model the upstream reported serving, when it differs from the request. | | -| `name` | *string* | :heavy_check_mark: | Check name. | auth_ok | -| `passed` | *boolean* | :heavy_check_mark: | N/A | | -| `reason` | [models.PrivateEndpointCheckReason](../models/privateendpointcheckreason.mdx) | :heavy_minus_sign: | Why the check failed. | no_byok_key | -| `upstreamMessage` | *string* | :heavy_minus_sign: | Error message returned by your deployment when the call failed. | | -| `upstreamStatus` | *number* | :heavy_minus_sign: | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file +| `actualModel` | *string* | ➖ | Model the upstream reported serving, when it differs from the request. | | +| `name` | *string* | ✅ | Check name. | auth_ok | +| `passed` | *boolean* | ✅ | N/A | | +| `reason` | [models.PrivateEndpointCheckReason](../models/privateendpointcheckreason.mdx) | ➖ | Why the check failed. | no_byok_key | +| `upstreamMessage` | *string* | ➖ | Error message returned by your deployment when the call failed. | | +| `upstreamStatus` | *number* | ➖ | HTTP status returned by your deployment when the call failed. | | \ No newline at end of file diff --git a/docs/models/privateendpointpricing.mdx b/docs/models/privateendpointpricing.mdx index bda4aab1b..24fc38dc4 100644 --- a/docs/models/privateendpointpricing.mdx +++ b/docs/models/privateendpointpricing.mdx @@ -19,5 +19,5 @@ let value: PrivateEndpointPricing = { | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `completion` | *string* | :heavy_check_mark: | USD per completion token, as a decimal string. | 0.00001 | -| `prompt` | *string* | :heavy_check_mark: | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file +| `completion` | *string* | ✅ | USD per completion token, as a decimal string. | 0.00001 | +| `prompt` | *string* | ✅ | USD per prompt token, as a decimal string. | 0.0000025 | \ No newline at end of file diff --git a/docs/models/privateendpointresponse.mdx b/docs/models/privateendpointresponse.mdx index 5dfda23d9..3f55f1225 100644 --- a/docs/models/privateendpointresponse.mdx +++ b/docs/models/privateendpointresponse.mdx @@ -32,4 +32,4 @@ let value: PrivateEndpointResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.PrivateEndpoint](../models/privateendpoint.mdx) | :heavy_check_mark: | N/A | \{
"base_url": "https://contoso.openai.azure.com",
"declared_region": "us",
"declared_zdr": true,
"id": "5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11",
"model_name": "OpenAI: GPT-4o",
"model_permaslug": "openai/gpt-4o-2024-08-06",
"model_slug": "openai/gpt-4o",
"pricing": \{
"completion": "0.00001",
"prompt": "0.0000025"
},
"provider_name": "Azure",
"provider_slug": "azure",
"status": "active",
"upstream_model_id": "gpt-4o-prod"
} | \ No newline at end of file +| `data` | [models.PrivateEndpoint](../models/privateendpoint.mdx) | ✅ | N/A | \{
"base_url": "https://contoso.openai.azure.com",
"declared_region": "us",
"declared_zdr": true,
"id": "5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11",
"model_name": "OpenAI: GPT-4o",
"model_permaslug": "openai/gpt-4o-2024-08-06",
"model_slug": "openai/gpt-4o",
"pricing": \{
"completion": "0.00001",
"prompt": "0.0000025"
},
"provider_name": "Azure",
"provider_slug": "azure",
"status": "active",
"upstream_model_id": "gpt-4o-prod"
} | \ No newline at end of file diff --git a/docs/models/privateendpointsummary.mdx b/docs/models/privateendpointsummary.mdx index 4159642b9..649f66ccf 100644 --- a/docs/models/privateendpointsummary.mdx +++ b/docs/models/privateendpointsummary.mdx @@ -22,10 +22,10 @@ let value: PrivateEndpointSummary = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | *string* | :heavy_check_mark: | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | -| `id` | *string* | :heavy_check_mark: | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | -| `modelName` | *string* | :heavy_check_mark: | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | -| `modelPermaslug` | *string* | :heavy_check_mark: | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | -| `modelSlug` | *string* | :heavy_check_mark: | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | -| `providerName` | *string* | :heavy_check_mark: | Display name of the upstream provider. | Azure | -| `status` | [models.PrivateEndpointStatus](../models/privateendpointstatus.mdx) | :heavy_check_mark: | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | \ No newline at end of file +| `createdAt` | *string* | ✅ | ISO timestamp of when the endpoint was created. | 2026-09-24T10:30:00Z | +| `id` | *string* | ✅ | Stable identifier of the private endpoint. | 5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11 | +| `modelName` | *string* | ✅ | Display name of the model, or `null` when the model is no longer listed. | OpenAI: GPT-4o | +| `modelPermaslug` | *string* | ✅ | Permanent slug of the model this endpoint serves. | openai/gpt-4o-2024-08-06 | +| `modelSlug` | *string* | ✅ | Public model slug, or `null` when the model is no longer listed. | openai/gpt-4o | +| `providerName` | *string* | ✅ | Display name of the upstream provider. | Azure | +| `status` | [models.PrivateEndpointStatus](../models/privateendpointstatus.mdx) | ✅ | Lifecycle state. `draft` endpoints are not routable until validated and activated; `disabled` endpoints are activated but temporarily not routable. | active | \ No newline at end of file diff --git a/docs/models/privateendpointvalidation.mdx b/docs/models/privateendpointvalidation.mdx index 3b9511b0b..bcf23b5bb 100644 --- a/docs/models/privateendpointvalidation.mdx +++ b/docs/models/privateendpointvalidation.mdx @@ -22,5 +22,5 @@ let value: PrivateEndpointValidation = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `checks` | [models.PrivateEndpointCheck](../models/privateendpointcheck.mdx)[] | :heavy_check_mark: | N/A | | -| `passed` | *boolean* | :heavy_check_mark: | Whether every check passed. | true | \ No newline at end of file +| `checks` | [models.PrivateEndpointCheck](../models/privateendpointcheck.mdx)[] | ✅ | N/A | | +| `passed` | *boolean* | ✅ | Whether every check passed. | true | \ No newline at end of file diff --git a/docs/models/privateendpointvalidationnullable.mdx b/docs/models/privateendpointvalidationnullable.mdx index adeea7abc..a2021863f 100644 --- a/docs/models/privateendpointvalidationnullable.mdx +++ b/docs/models/privateendpointvalidationnullable.mdx @@ -22,5 +22,5 @@ let value: PrivateEndpointValidationNullable = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `checks` | [models.PrivateEndpointCheck](../models/privateendpointcheck.mdx)[] | :heavy_check_mark: | N/A | | -| `passed` | *boolean* | :heavy_check_mark: | Whether every check passed. | true | \ No newline at end of file +| `checks` | [models.PrivateEndpointCheck](../models/privateendpointcheck.mdx)[] | ✅ | N/A | | +| `passed` | *boolean* | ✅ | Whether every check passed. | true | \ No newline at end of file diff --git a/docs/models/privateendpointvalidationresponse.mdx b/docs/models/privateendpointvalidationresponse.mdx index 6ade23890..404d44518 100644 --- a/docs/models/privateendpointvalidationresponse.mdx +++ b/docs/models/privateendpointvalidationresponse.mdx @@ -24,4 +24,4 @@ let value: PrivateEndpointValidationResponse = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `data` | [models.PrivateEndpointValidation](../models/privateendpointvalidation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.PrivateEndpointValidation](../models/privateendpointvalidation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/progress.mdx b/docs/models/progress.mdx index afe639924..e49ee5c9f 100644 --- a/docs/models/progress.mdx +++ b/docs/models/progress.mdx @@ -20,6 +20,6 @@ let value: Progress = { | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `stepLabel` | *string* | :heavy_check_mark: | Human-readable label of the active provisioning step. | -| `stepNumber` | *number* | :heavy_check_mark: | One-based index of the active step. | -| `totalSteps` | *number* | :heavy_check_mark: | Number of provisioning steps. | \ No newline at end of file +| `stepLabel` | *string* | ✅ | Human-readable label of the active provisioning step. | +| `stepNumber` | *number* | ✅ | One-based index of the active step. | +| `totalSteps` | *number* | ✅ | Number of provisioning steps. | \ No newline at end of file diff --git a/docs/models/promptcachebreakpoint.mdx b/docs/models/promptcachebreakpoint.mdx index 371a22a55..ed2950a67 100644 --- a/docs/models/promptcachebreakpoint.mdx +++ b/docs/models/promptcachebreakpoint.mdx @@ -18,4 +18,4 @@ let value: PromptCacheBreakpoint = { | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `mode` | [models.PromptCacheBreakpointMode](../models/promptcachebreakpointmode.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `mode` | [models.PromptCacheBreakpointMode](../models/promptcachebreakpointmode.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/promptcacheoptions.mdx b/docs/models/promptcacheoptions.mdx index 6eeef981b..32d85b61d 100644 --- a/docs/models/promptcacheoptions.mdx +++ b/docs/models/promptcacheoptions.mdx @@ -18,5 +18,5 @@ let value: PromptCacheOptions = { | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `mode` | [models.PromptCacheOptionsMode](../models/promptcacheoptionsmode.mdx) | :heavy_check_mark: | N/A | -| `ttl` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `mode` | [models.PromptCacheOptionsMode](../models/promptcacheoptionsmode.mdx) | ✅ | N/A | +| `ttl` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/provideroptions.mdx b/docs/models/provideroptions.mdx index 264d5e64c..70a974957 100644 --- a/docs/models/provideroptions.mdx +++ b/docs/models/provideroptions.mdx @@ -16,149 +16,149 @@ let value: ProviderOptions = {}; | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `oneai` | Record\ | :heavy_minus_sign: | N/A | -| `ai21` | Record\ | :heavy_minus_sign: | N/A | -| `aionLabs` | Record\ | :heavy_minus_sign: | N/A | -| `akashml` | Record\ | :heavy_minus_sign: | N/A | -| `alibaba` | Record\ | :heavy_minus_sign: | N/A | -| `amazonBedrock` | Record\ | :heavy_minus_sign: | N/A | -| `amazonBedrockClaudeOnAws` | Record\ | :heavy_minus_sign: | N/A | -| `amazonNova` | Record\ | :heavy_minus_sign: | N/A | -| `ambient` | Record\ | :heavy_minus_sign: | N/A | -| `anthropic` | Record\ | :heavy_minus_sign: | N/A | -| `anthropic2` | Record\ | :heavy_minus_sign: | N/A | -| `anyscale` | Record\ | :heavy_minus_sign: | N/A | -| `arceeAi` | Record\ | :heavy_minus_sign: | N/A | -| `assemblyai` | Record\ | :heavy_minus_sign: | N/A | -| `atlasCloud` | Record\ | :heavy_minus_sign: | N/A | -| `atoma` | Record\ | :heavy_minus_sign: | N/A | -| `avian` | Record\ | :heavy_minus_sign: | N/A | -| `azure` | Record\ | :heavy_minus_sign: | N/A | -| `baidu` | Record\ | :heavy_minus_sign: | N/A | -| `baseten` | Record\ | :heavy_minus_sign: | N/A | -| `blackForestLabs` | Record\ | :heavy_minus_sign: | N/A | -| `byteplus` | Record\ | :heavy_minus_sign: | N/A | -| `centml` | Record\ | :heavy_minus_sign: | N/A | -| `cerebras` | Record\ | :heavy_minus_sign: | N/A | -| `chutes` | Record\ | :heavy_minus_sign: | N/A | -| `cirrascale` | Record\ | :heavy_minus_sign: | N/A | -| `clarifai` | Record\ | :heavy_minus_sign: | N/A | -| `claudeOnAws` | Record\ | :heavy_minus_sign: | N/A | -| `cloudflare` | Record\ | :heavy_minus_sign: | N/A | -| `cohere` | Record\ | :heavy_minus_sign: | N/A | -| `coreweave` | Record\ | :heavy_minus_sign: | N/A | -| `cosine` | Record\ | :heavy_minus_sign: | N/A | -| `crofai` | Record\ | :heavy_minus_sign: | N/A | -| `crucible` | Record\ | :heavy_minus_sign: | N/A | -| `crusoe` | Record\ | :heavy_minus_sign: | N/A | -| `darkbloom` | Record\ | :heavy_minus_sign: | N/A | -| `databricks` | Record\ | :heavy_minus_sign: | N/A | -| `decart` | Record\ | :heavy_minus_sign: | N/A | -| `deepgram` | Record\ | :heavy_minus_sign: | N/A | -| `deepinfra` | Record\ | :heavy_minus_sign: | N/A | -| `deepseek` | Record\ | :heavy_minus_sign: | N/A | -| `dekallm` | Record\ | :heavy_minus_sign: | N/A | -| `digitalocean` | Record\ | :heavy_minus_sign: | N/A | -| `elevenlabs` | Record\ | :heavy_minus_sign: | N/A | -| `enfer` | Record\ | :heavy_minus_sign: | N/A | -| `fakeProvider` | Record\ | :heavy_minus_sign: | N/A | -| `featherless` | Record\ | :heavy_minus_sign: | N/A | -| `fireworks` | Record\ | :heavy_minus_sign: | N/A | -| `fishAudio` | Record\ | :heavy_minus_sign: | N/A | -| `friendli` | Record\ | :heavy_minus_sign: | N/A | -| `gmicloud` | Record\ | :heavy_minus_sign: | N/A | -| `googleAiStudio` | Record\ | :heavy_minus_sign: | N/A | -| `googleVertex` | Record\ | :heavy_minus_sign: | N/A | -| `gopomelo` | Record\ | :heavy_minus_sign: | N/A | -| `groq` | Record\ | :heavy_minus_sign: | N/A | -| `heygen` | Record\ | :heavy_minus_sign: | N/A | -| `huggingface` | Record\ | :heavy_minus_sign: | N/A | -| `hyperbolic` | Record\ | :heavy_minus_sign: | N/A | -| `hyperbolicQuantized` | Record\ | :heavy_minus_sign: | N/A | -| `inception` | Record\ | :heavy_minus_sign: | N/A | -| `inceptron` | Record\ | :heavy_minus_sign: | N/A | -| `inferactVllm` | Record\ | :heavy_minus_sign: | N/A | -| `inferenceNet` | Record\ | :heavy_minus_sign: | N/A | -| `infermatic` | Record\ | :heavy_minus_sign: | N/A | -| `inflection` | Record\ | :heavy_minus_sign: | N/A | -| `inocloud` | Record\ | :heavy_minus_sign: | N/A | -| `ioNet` | Record\ | :heavy_minus_sign: | N/A | -| `ionstream` | Record\ | :heavy_minus_sign: | N/A | -| `klusterai` | Record\ | :heavy_minus_sign: | N/A | -| `krea` | Record\ | :heavy_minus_sign: | N/A | -| `lambda` | Record\ | :heavy_minus_sign: | N/A | -| `lepton` | Record\ | :heavy_minus_sign: | N/A | -| `liquid` | Record\ | :heavy_minus_sign: | N/A | -| `lynn` | Record\ | :heavy_minus_sign: | N/A | -| `lynnPrivate` | Record\ | :heavy_minus_sign: | N/A | -| `makora` | Record\ | :heavy_minus_sign: | N/A | -| `mancer` | Record\ | :heavy_minus_sign: | N/A | -| `mancerOld` | Record\ | :heavy_minus_sign: | N/A | -| `mara` | Record\ | :heavy_minus_sign: | N/A | -| `meta` | Record\ | :heavy_minus_sign: | N/A | -| `minimax` | Record\ | :heavy_minus_sign: | N/A | -| `mistral` | Record\ | :heavy_minus_sign: | N/A | -| `modal` | Record\ | :heavy_minus_sign: | N/A | -| `modelrun` | Record\ | :heavy_minus_sign: | N/A | -| `modular` | Record\ | :heavy_minus_sign: | N/A | -| `moonshotai` | Record\ | :heavy_minus_sign: | N/A | -| `morph` | Record\ | :heavy_minus_sign: | N/A | -| `ncompass` | Record\ | :heavy_minus_sign: | N/A | -| `nearAi` | Record\ | :heavy_minus_sign: | N/A | -| `nebius` | Record\ | :heavy_minus_sign: | N/A | -| `nexAgi` | Record\ | :heavy_minus_sign: | N/A | -| `nextbit` | Record\ | :heavy_minus_sign: | N/A | -| `nineteen` | Record\ | :heavy_minus_sign: | N/A | -| `novita` | Record\ | :heavy_minus_sign: | N/A | -| `nvidia` | Record\ | :heavy_minus_sign: | N/A | -| `octoai` | Record\ | :heavy_minus_sign: | N/A | -| `ollama` | Record\ | :heavy_minus_sign: | N/A | -| `openInference` | Record\ | :heavy_minus_sign: | N/A | -| `openai` | Record\ | :heavy_minus_sign: | N/A | -| `parasail` | Record\ | :heavy_minus_sign: | N/A | -| `perceptron` | Record\ | :heavy_minus_sign: | N/A | -| `perplexity` | Record\ | :heavy_minus_sign: | N/A | -| `phala` | Record\ | :heavy_minus_sign: | N/A | -| `poolside` | Record\ | :heavy_minus_sign: | N/A | -| `primeintellect` | Record\ | :heavy_minus_sign: | N/A | -| `quiver` | Record\ | :heavy_minus_sign: | N/A | -| `recraft` | Record\ | :heavy_minus_sign: | N/A | -| `recursal` | Record\ | :heavy_minus_sign: | N/A | -| `reflection` | Record\ | :heavy_minus_sign: | N/A | -| `reka` | Record\ | :heavy_minus_sign: | N/A | -| `relace` | Record\ | :heavy_minus_sign: | N/A | -| `replicate` | Record\ | :heavy_minus_sign: | N/A | -| `respan` | Record\ | :heavy_minus_sign: | N/A | -| `runway` | Record\ | :heavy_minus_sign: | N/A | -| `sailResearch` | Record\ | :heavy_minus_sign: | N/A | -| `sakana` | Record\ | :heavy_minus_sign: | N/A | -| `sakanaAi` | Record\ | :heavy_minus_sign: | N/A | -| `sambanova` | Record\ | :heavy_minus_sign: | N/A | -| `sambanovaCloaked` | Record\ | :heavy_minus_sign: | N/A | -| `scaledown` | Record\ | :heavy_minus_sign: | N/A | -| `seed` | Record\ | :heavy_minus_sign: | N/A | -| `sfCompute` | Record\ | :heavy_minus_sign: | N/A | -| `siliconflow` | Record\ | :heavy_minus_sign: | N/A | -| `sourceful` | Record\ | :heavy_minus_sign: | N/A | -| `stealth` | Record\ | :heavy_minus_sign: | N/A | -| `stepfun` | Record\ | :heavy_minus_sign: | N/A | -| `streamlake` | Record\ | :heavy_minus_sign: | N/A | -| `switchpoint` | Record\ | :heavy_minus_sign: | N/A | -| `targon` | Record\ | :heavy_minus_sign: | N/A | -| `tencent` | Record\ | :heavy_minus_sign: | N/A | -| `tenstorrent` | Record\ | :heavy_minus_sign: | N/A | -| `thinkingmachines` | Record\ | :heavy_minus_sign: | N/A | -| `together` | Record\ | :heavy_minus_sign: | N/A | -| `togetherLite` | Record\ | :heavy_minus_sign: | N/A | -| `typesafe` | Record\ | :heavy_minus_sign: | N/A | -| `ubicloud` | Record\ | :heavy_minus_sign: | N/A | -| `unbiased` | Record\ | :heavy_minus_sign: | N/A | -| `upstage` | Record\ | :heavy_minus_sign: | N/A | -| `venice` | Record\ | :heavy_minus_sign: | N/A | -| `voyageai` | Record\ | :heavy_minus_sign: | N/A | -| `wafer` | Record\ | :heavy_minus_sign: | N/A | -| `wandb` | Record\ | :heavy_minus_sign: | N/A | -| `wandbLegacy` | Record\ | :heavy_minus_sign: | N/A | -| `xai` | Record\ | :heavy_minus_sign: | N/A | -| `xiaomi` | Record\ | :heavy_minus_sign: | N/A | -| `zAi` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `oneai` | Record\ | ➖ | N/A | +| `ai21` | Record\ | ➖ | N/A | +| `aionLabs` | Record\ | ➖ | N/A | +| `akashml` | Record\ | ➖ | N/A | +| `alibaba` | Record\ | ➖ | N/A | +| `amazonBedrock` | Record\ | ➖ | N/A | +| `amazonBedrockClaudeOnAws` | Record\ | ➖ | N/A | +| `amazonNova` | Record\ | ➖ | N/A | +| `ambient` | Record\ | ➖ | N/A | +| `anthropic` | Record\ | ➖ | N/A | +| `anthropic2` | Record\ | ➖ | N/A | +| `anyscale` | Record\ | ➖ | N/A | +| `arceeAi` | Record\ | ➖ | N/A | +| `assemblyai` | Record\ | ➖ | N/A | +| `atlasCloud` | Record\ | ➖ | N/A | +| `atoma` | Record\ | ➖ | N/A | +| `avian` | Record\ | ➖ | N/A | +| `azure` | Record\ | ➖ | N/A | +| `baidu` | Record\ | ➖ | N/A | +| `baseten` | Record\ | ➖ | N/A | +| `blackForestLabs` | Record\ | ➖ | N/A | +| `byteplus` | Record\ | ➖ | N/A | +| `centml` | Record\ | ➖ | N/A | +| `cerebras` | Record\ | ➖ | N/A | +| `chutes` | Record\ | ➖ | N/A | +| `cirrascale` | Record\ | ➖ | N/A | +| `clarifai` | Record\ | ➖ | N/A | +| `claudeOnAws` | Record\ | ➖ | N/A | +| `cloudflare` | Record\ | ➖ | N/A | +| `cohere` | Record\ | ➖ | N/A | +| `coreweave` | Record\ | ➖ | N/A | +| `cosine` | Record\ | ➖ | N/A | +| `crofai` | Record\ | ➖ | N/A | +| `crucible` | Record\ | ➖ | N/A | +| `crusoe` | Record\ | ➖ | N/A | +| `darkbloom` | Record\ | ➖ | N/A | +| `databricks` | Record\ | ➖ | N/A | +| `decart` | Record\ | ➖ | N/A | +| `deepgram` | Record\ | ➖ | N/A | +| `deepinfra` | Record\ | ➖ | N/A | +| `deepseek` | Record\ | ➖ | N/A | +| `dekallm` | Record\ | ➖ | N/A | +| `digitalocean` | Record\ | ➖ | N/A | +| `elevenlabs` | Record\ | ➖ | N/A | +| `enfer` | Record\ | ➖ | N/A | +| `fakeProvider` | Record\ | ➖ | N/A | +| `featherless` | Record\ | ➖ | N/A | +| `fireworks` | Record\ | ➖ | N/A | +| `fishAudio` | Record\ | ➖ | N/A | +| `friendli` | Record\ | ➖ | N/A | +| `gmicloud` | Record\ | ➖ | N/A | +| `googleAiStudio` | Record\ | ➖ | N/A | +| `googleVertex` | Record\ | ➖ | N/A | +| `gopomelo` | Record\ | ➖ | N/A | +| `groq` | Record\ | ➖ | N/A | +| `heygen` | Record\ | ➖ | N/A | +| `huggingface` | Record\ | ➖ | N/A | +| `hyperbolic` | Record\ | ➖ | N/A | +| `hyperbolicQuantized` | Record\ | ➖ | N/A | +| `inception` | Record\ | ➖ | N/A | +| `inceptron` | Record\ | ➖ | N/A | +| `inferactVllm` | Record\ | ➖ | N/A | +| `inferenceNet` | Record\ | ➖ | N/A | +| `infermatic` | Record\ | ➖ | N/A | +| `inflection` | Record\ | ➖ | N/A | +| `inocloud` | Record\ | ➖ | N/A | +| `ioNet` | Record\ | ➖ | N/A | +| `ionstream` | Record\ | ➖ | N/A | +| `klusterai` | Record\ | ➖ | N/A | +| `krea` | Record\ | ➖ | N/A | +| `lambda` | Record\ | ➖ | N/A | +| `lepton` | Record\ | ➖ | N/A | +| `liquid` | Record\ | ➖ | N/A | +| `lynn` | Record\ | ➖ | N/A | +| `lynnPrivate` | Record\ | ➖ | N/A | +| `makora` | Record\ | ➖ | N/A | +| `mancer` | Record\ | ➖ | N/A | +| `mancerOld` | Record\ | ➖ | N/A | +| `mara` | Record\ | ➖ | N/A | +| `meta` | Record\ | ➖ | N/A | +| `minimax` | Record\ | ➖ | N/A | +| `mistral` | Record\ | ➖ | N/A | +| `modal` | Record\ | ➖ | N/A | +| `modelrun` | Record\ | ➖ | N/A | +| `modular` | Record\ | ➖ | N/A | +| `moonshotai` | Record\ | ➖ | N/A | +| `morph` | Record\ | ➖ | N/A | +| `ncompass` | Record\ | ➖ | N/A | +| `nearAi` | Record\ | ➖ | N/A | +| `nebius` | Record\ | ➖ | N/A | +| `nexAgi` | Record\ | ➖ | N/A | +| `nextbit` | Record\ | ➖ | N/A | +| `nineteen` | Record\ | ➖ | N/A | +| `novita` | Record\ | ➖ | N/A | +| `nvidia` | Record\ | ➖ | N/A | +| `octoai` | Record\ | ➖ | N/A | +| `ollama` | Record\ | ➖ | N/A | +| `openInference` | Record\ | ➖ | N/A | +| `openai` | Record\ | ➖ | N/A | +| `parasail` | Record\ | ➖ | N/A | +| `perceptron` | Record\ | ➖ | N/A | +| `perplexity` | Record\ | ➖ | N/A | +| `phala` | Record\ | ➖ | N/A | +| `poolside` | Record\ | ➖ | N/A | +| `primeintellect` | Record\ | ➖ | N/A | +| `quiver` | Record\ | ➖ | N/A | +| `recraft` | Record\ | ➖ | N/A | +| `recursal` | Record\ | ➖ | N/A | +| `reflection` | Record\ | ➖ | N/A | +| `reka` | Record\ | ➖ | N/A | +| `relace` | Record\ | ➖ | N/A | +| `replicate` | Record\ | ➖ | N/A | +| `respan` | Record\ | ➖ | N/A | +| `runway` | Record\ | ➖ | N/A | +| `sailResearch` | Record\ | ➖ | N/A | +| `sakana` | Record\ | ➖ | N/A | +| `sakanaAi` | Record\ | ➖ | N/A | +| `sambanova` | Record\ | ➖ | N/A | +| `sambanovaCloaked` | Record\ | ➖ | N/A | +| `scaledown` | Record\ | ➖ | N/A | +| `seed` | Record\ | ➖ | N/A | +| `sfCompute` | Record\ | ➖ | N/A | +| `siliconflow` | Record\ | ➖ | N/A | +| `sourceful` | Record\ | ➖ | N/A | +| `stealth` | Record\ | ➖ | N/A | +| `stepfun` | Record\ | ➖ | N/A | +| `streamlake` | Record\ | ➖ | N/A | +| `switchpoint` | Record\ | ➖ | N/A | +| `targon` | Record\ | ➖ | N/A | +| `tencent` | Record\ | ➖ | N/A | +| `tenstorrent` | Record\ | ➖ | N/A | +| `thinkingmachines` | Record\ | ➖ | N/A | +| `together` | Record\ | ➖ | N/A | +| `togetherLite` | Record\ | ➖ | N/A | +| `typesafe` | Record\ | ➖ | N/A | +| `ubicloud` | Record\ | ➖ | N/A | +| `unbiased` | Record\ | ➖ | N/A | +| `upstage` | Record\ | ➖ | N/A | +| `venice` | Record\ | ➖ | N/A | +| `voyageai` | Record\ | ➖ | N/A | +| `wafer` | Record\ | ➖ | N/A | +| `wandb` | Record\ | ➖ | N/A | +| `wandbLegacy` | Record\ | ➖ | N/A | +| `xai` | Record\ | ➖ | N/A | +| `xiaomi` | Record\ | ➖ | N/A | +| `zAi` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/provideroverloadedresponseerrordata.mdx b/docs/models/provideroverloadedresponseerrordata.mdx index 8a0a8f31c..362958051 100644 --- a/docs/models/provideroverloadedresponseerrordata.mdx +++ b/docs/models/provideroverloadedresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: ProviderOverloadedResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/providerpreferences.mdx b/docs/models/providerpreferences.mdx index 6d071b02e..fbfb7d7d9 100644 --- a/docs/models/providerpreferences.mdx +++ b/docs/models/providerpreferences.mdx @@ -16,17 +16,17 @@ let value: ProviderPreferences = {}; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowFallbacks` | *boolean* | :heavy_minus_sign: | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | -| `dataCollection` | [models.DataCollection](../models/datacollection.mdx) | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | -| `enforceDistillableText` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true | -| `ignore` | *models.ProviderPreferencesIgnore*[] | :heavy_minus_sign: | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | -| `maxPrice` | [models.MaxPrice](../models/maxprice.mdx) | :heavy_minus_sign: | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. | | -| `only` | *models.ProviderPreferencesOnly*[] | :heavy_minus_sign: | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | -| `options` | [models.ProviderOptions](../models/provideroptions.mdx) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | -| `order` | *models.ProviderPreferencesOrder*[] | :heavy_minus_sign: | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | -| `preferredMaxLatency` | *models.PreferredMaxLatency* | :heavy_minus_sign: | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | -| `preferredMinThroughput` | *models.PreferredMinThroughput* | :heavy_minus_sign: | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | -| `quantizations` | [models.Quantization](../models/quantization.mdx)[] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | -| `requireParameters` | *boolean* | :heavy_minus_sign: | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | | -| `sort` | *models.ProviderPreferencesSort* | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | -| `zdr` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file +| `allowFallbacks` | *boolean* | ➖ | Whether to allow backup providers to serve requests
- true: (default) when the primary provider (or your custom providers in "order") is unavailable, use the next best provider.
- false: use only the primary/custom provider, and return the upstream error if it's unavailable.
| | +| `dataCollection` | [models.DataCollection](../models/datacollection.mdx) | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | +| `enforceDistillableText` | *boolean* | ➖ | Whether to restrict routing to only models that allow text distillation. When true, only models where the author has allowed distillation will be used. | true | +| `ignore` | *models.ProviderPreferencesIgnore*[] | ➖ | List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request. | [
"openai",
"anthropic"
] | +| `maxPrice` | [models.MaxPrice](../models/maxprice.mdx) | ➖ | The object specifying the maximum price you want to pay for this request. USD price per million tokens, for prompt and completion. | | +| `only` | *models.ProviderPreferencesOnly*[] | ➖ | List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request. | [
"openai",
"anthropic"
] | +| `options` | [models.ProviderOptions](../models/provideroptions.mdx) | ➖ | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | +| `order` | *models.ProviderPreferencesOrder*[] | ➖ | An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message. | [
"openai",
"anthropic"
] | +| `preferredMaxLatency` | *models.PreferredMaxLatency* | ➖ | Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 5 | +| `preferredMinThroughput` | *models.PreferredMinThroughput* | ➖ | Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold. | 100 | +| `quantizations` | [models.Quantization](../models/quantization.mdx)[] | ➖ | A list of quantization levels to filter the provider by. | | +| `requireParameters` | *boolean* | ➖ | Whether to filter providers to only those that support the parameters you've provided. If this setting is omitted or set to false, then providers will receive only the parameters they support, and ignore the rest. | | +| `sort` | *models.ProviderPreferencesSort* | ➖ | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | +| `zdr` | *boolean* | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/providerresponse.mdx b/docs/models/providerresponse.mdx index 777e899e3..795b4715e 100644 --- a/docs/models/providerresponse.mdx +++ b/docs/models/providerresponse.mdx @@ -18,11 +18,11 @@ let value: ProviderResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `endpointId` | *string* | :heavy_minus_sign: | Internal endpoint identifier | ep_abc123 | -| `id` | *string* | :heavy_minus_sign: | Upstream provider response identifier | chatcmpl-abc123 | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether the request used a bring-your-own-key | false | -| `latency` | *number* | :heavy_minus_sign: | Response latency in milliseconds | 1200 | -| `modelPermaslug` | *string* | :heavy_minus_sign: | Canonical model slug | openai/gpt-4 | -| `providerName` | [models.ProviderResponseProviderName](../models/providerresponseprovidername.mdx) | :heavy_minus_sign: | Name of the provider | OpenAI | -| `routedServiceTier` | [models.RoutedServiceTier](../models/routedservicetier.mdx) | :heavy_minus_sign: | The service tier this request was routed to (e.g. flex, priority). The tier actually applied and billed is determined by the provider response and may differ. | priority | -| `status` | *number* | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file +| `endpointId` | *string* | ➖ | Internal endpoint identifier | ep_abc123 | +| `id` | *string* | ➖ | Upstream provider response identifier | chatcmpl-abc123 | +| `isByok` | *boolean* | ➖ | Whether the request used a bring-your-own-key | false | +| `latency` | *number* | ➖ | Response latency in milliseconds | 1200 | +| `modelPermaslug` | *string* | ➖ | Canonical model slug | openai/gpt-4 | +| `providerName` | [models.ProviderResponseProviderName](../models/providerresponseprovidername.mdx) | ➖ | Name of the provider | OpenAI | +| `routedServiceTier` | [models.RoutedServiceTier](../models/routedservicetier.mdx) | ➖ | The service tier this request was routed to (e.g. flex, priority). The tier actually applied and billed is determined by the provider response and may differ. | priority | +| `status` | *number* | ✅ | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/docs/models/providersortconfig.mdx b/docs/models/providersortconfig.mdx index a45a98ba7..e7f4c09c6 100644 --- a/docs/models/providersortconfig.mdx +++ b/docs/models/providersortconfig.mdx @@ -16,5 +16,5 @@ let value: ProviderSortConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `by` | [models.By](../models/by.mdx) | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | -| `partition` | [models.Partition](../models/partition.mdx) | :heavy_minus_sign: | Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. | model | \ No newline at end of file +| `by` | [models.By](../models/by.mdx) | ➖ | The provider sorting strategy (price, throughput, latency) | price | +| `partition` | [models.Partition](../models/partition.mdx) | ➖ | Partitioning strategy for sorting: "model" (default) groups endpoints by model before sorting (fallback models remain fallbacks), "none" sorts all endpoints together regardless of model. | model | \ No newline at end of file diff --git a/docs/models/provisioninternresponse.mdx b/docs/models/provisioninternresponse.mdx index f39845ad4..a4995b0f7 100644 --- a/docs/models/provisioninternresponse.mdx +++ b/docs/models/provisioninternresponse.mdx @@ -16,4 +16,4 @@ let value: ProvisionInternResponse = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `provisioning` | *true* | :heavy_check_mark: | N/A | \ No newline at end of file +| `provisioning` | *true* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/publicendpoint.mdx b/docs/models/publicendpoint.mdx index 155bdce41..f5213b1b1 100644 --- a/docs/models/publicendpoint.mdx +++ b/docs/models/publicendpoint.mdx @@ -62,27 +62,27 @@ let value: PublicEndpoint = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contextLength` | *number* | :heavy_check_mark: | N/A | | -| `latencyLast30m` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | Latency percentiles in milliseconds over the last 30 minutes. Latency measures time to first token. Only visible when authenticated with an API key or cookie; returns null for unauthenticated requests. | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `maxCompletionTokens` | *number* | :heavy_check_mark: | Maximum completion tokens for this endpoint. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | | -| `maxPromptTokens` | *number* | :heavy_check_mark: | N/A | | -| `modelId` | *string* | :heavy_check_mark: | The unique identifier for the model (permaslug) | openai/gpt-4 | -| `modelName` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `nativeTools` | Record\ | :heavy_check_mark: | The server tools this endpoint accepts as the provider's own built-in tool (`engine: "native"`) instead of an OpenRouter engine, keyed by canonical `openrouter:*` name. Each value names the provider tool type the request is translated to. Where that tool runs (provider-side, or returned to the client as with Anthropic bash) is documented per tool. Empty when the provider has none. | \{
"openrouter:web_search": \{
"type": "web_search_20260209"
}
} | -| `perfLast30mByWorkload` | [models.PerfLast30mByWorkload](../models/perflast30mbyworkload.mdx) | :heavy_minus_sign: | Endpoint performance over the last 30 minutes, keyed by the kind of request served (e.g. `text_generation`, `image_generation`). Additive to the legacy singular latency and throughput fields; image and video generation report end-to-end latency. Only visible when authenticated with an API key or cookie. | | -| `pricing` | [models.Pricing](../models/pricing.mdx) | :heavy_check_mark: | N/A | | -| `providerName` | [models.ProviderName](../models/providername.mdx) | :heavy_check_mark: | N/A | OpenAI | -| `quantization` | [models.Quantization](../models/quantization.mdx) | :heavy_check_mark: | N/A | fp16 | -| `status` | [models.EndpointStatus](../models/endpointstatus.mdx) | :heavy_minus_sign: | N/A | 0 | -| `supportedParameters` | [models.Parameter](../models/parameter.mdx)[] | :heavy_check_mark: | N/A | | -| `supportsImageReference` | *boolean* | :heavy_minus_sign: | Whether this TTS endpoint accepts an `image_url` reference describing the desired voice. Requests carrying an image reference are only routed to endpoints where this is true. | | -| `supportsImplicitCaching` | *boolean* | :heavy_check_mark: | N/A | | -| `supportsMultipleAudioReferences` | *boolean* | :heavy_minus_sign: | Whether this TTS endpoint accepts more than one `input_audio` reference clip per request. Requests carrying several clips are only routed to endpoints where this is true. | | -| `supportsToolChoice` | [models.ToolChoiceSupport](../models/toolchoicesupport.mdx) | :heavy_check_mark: | Per-variant `tool_choice` support. `tool_choice` in `supported_parameters` only says the parameter is accepted; these flags say which of its values passed testing. | \{
"auto": true,
"function": true,
"none": true,
"required": true
} | -| `supportsVoiceCloning` | *boolean* | :heavy_minus_sign: | Whether this TTS endpoint accepts inline reference audio (`input_references`) for stateless voice cloning. Requests carrying reference audio are only routed to endpoints where this is true. | | -| `tag` | *string* | :heavy_check_mark: | N/A | | -| `throughputLast30m` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `uptimeLast1d` | *number* | :heavy_check_mark: | Uptime percentage over the last 1 day, calculated as successful requests / (successful + error requests) * 100. Rate-limited requests are excluded. Returns null if insufficient data. | | -| `uptimeLast30m` | *number* | :heavy_check_mark: | N/A | | -| `uptimeLast5m` | *number* | :heavy_check_mark: | Uptime percentage over the last 5 minutes, calculated as successful requests / (successful + error requests) * 100. Rate-limited requests are excluded. Returns null if insufficient data. | | \ No newline at end of file +| `contextLength` | *number* | ✅ | N/A | | +| `latencyLast30m` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | Latency percentiles in milliseconds over the last 30 minutes. Latency measures time to first token. Only visible when authenticated with an API key or cookie; returns null for unauthenticated requests. | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `maxCompletionTokens` | *number* | ✅ | Maximum completion tokens for this endpoint. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | | +| `maxPromptTokens` | *number* | ✅ | N/A | | +| `modelId` | *string* | ✅ | The unique identifier for the model (permaslug) | openai/gpt-4 | +| `modelName` | *string* | ✅ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `nativeTools` | Record\ | ✅ | The server tools this endpoint accepts as the provider's own built-in tool (`engine: "native"`) instead of an OpenRouter engine, keyed by canonical `openrouter:*` name. Each value names the provider tool type the request is translated to. Where that tool runs (provider-side, or returned to the client as with Anthropic bash) is documented per tool. Empty when the provider has none. | \{
"openrouter:web_search": \{
"type": "web_search_20260209"
}
} | +| `perfLast30mByWorkload` | [models.PerfLast30mByWorkload](../models/perflast30mbyworkload.mdx) | ➖ | Endpoint performance over the last 30 minutes, keyed by the kind of request served (e.g. `text_generation`, `image_generation`). Additive to the legacy singular latency and throughput fields; image and video generation report end-to-end latency. Only visible when authenticated with an API key or cookie. | | +| `pricing` | [models.Pricing](../models/pricing.mdx) | ✅ | N/A | | +| `providerName` | [models.ProviderName](../models/providername.mdx) | ✅ | N/A | OpenAI | +| `quantization` | [models.Quantization](../models/quantization.mdx) | ✅ | N/A | fp16 | +| `status` | [models.EndpointStatus](../models/endpointstatus.mdx) | ➖ | N/A | 0 | +| `supportedParameters` | [models.Parameter](../models/parameter.mdx)[] | ✅ | N/A | | +| `supportsImageReference` | *boolean* | ➖ | Whether this TTS endpoint accepts an `image_url` reference describing the desired voice. Requests carrying an image reference are only routed to endpoints where this is true. | | +| `supportsImplicitCaching` | *boolean* | ✅ | N/A | | +| `supportsMultipleAudioReferences` | *boolean* | ➖ | Whether this TTS endpoint accepts more than one `input_audio` reference clip per request. Requests carrying several clips are only routed to endpoints where this is true. | | +| `supportsToolChoice` | [models.ToolChoiceSupport](../models/toolchoicesupport.mdx) | ✅ | Per-variant `tool_choice` support. `tool_choice` in `supported_parameters` only says the parameter is accepted; these flags say which of its values passed testing. | \{
"auto": true,
"function": true,
"none": true,
"required": true
} | +| `supportsVoiceCloning` | *boolean* | ➖ | Whether this TTS endpoint accepts inline reference audio (`input_references`) for stateless voice cloning. Requests carrying reference audio are only routed to endpoints where this is true. | | +| `tag` | *string* | ✅ | N/A | | +| `throughputLast30m` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `uptimeLast1d` | *number* | ✅ | Uptime percentage over the last 1 day, calculated as successful requests / (successful + error requests) * 100. Rate-limited requests are excluded. Returns null if insufficient data. | | +| `uptimeLast30m` | *number* | ✅ | N/A | | +| `uptimeLast5m` | *number* | ✅ | Uptime percentage over the last 5 minutes, calculated as successful requests / (successful + error requests) * 100. Rate-limited requests are excluded. Returns null if insufficient data. | | \ No newline at end of file diff --git a/docs/models/publicpricing.mdx b/docs/models/publicpricing.mdx index b886478f5..7cc5994ec 100644 --- a/docs/models/publicpricing.mdx +++ b/docs/models/publicpricing.mdx @@ -19,19 +19,19 @@ let value: PublicPricing = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `audio` | *string* | :heavy_minus_sign: | Price in USD per audio input token | -| `audioOutput` | *string* | :heavy_minus_sign: | Price in USD per audio output token | -| `completion` | *string* | :heavy_check_mark: | Price in USD per token for completion (output) generation | -| `discount` | *number* | :heavy_minus_sign: | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | -| `image` | *string* | :heavy_minus_sign: | Price in USD per input image | -| `imageOutput` | *string* | :heavy_minus_sign: | Price in USD per output image | -| `imageToken` | *string* | :heavy_minus_sign: | Price in USD per image token | -| `inputAudioCache` | *string* | :heavy_minus_sign: | Price in USD per cached audio input token | -| `inputCacheRead` | *string* | :heavy_minus_sign: | Price in USD per cached input token (read) | -| `inputCacheWrite` | *string* | :heavy_minus_sign: | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | -| `inputCacheWrite1h` | *string* | :heavy_minus_sign: | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | -| `internalReasoning` | *string* | :heavy_minus_sign: | Price in USD per internal reasoning token | -| `overrides` | [models.PricingOverride](../models/pricingoverride.mdx)[] | :heavy_minus_sign: | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | -| `prompt` | *string* | :heavy_check_mark: | Price in USD per token for prompt (input) processing | -| `request` | *string* | :heavy_minus_sign: | Price in USD per request | -| `webSearch` | *string* | :heavy_minus_sign: | Price in USD per web search | \ No newline at end of file +| `audio` | *string* | ➖ | Price in USD per audio input token | +| `audioOutput` | *string* | ➖ | Price in USD per audio output token | +| `completion` | *string* | ✅ | Price in USD per token for completion (output) generation | +| `discount` | *number* | ➖ | Fractional discount applied to this endpoint's pricing; the price is multiplied by (1 - discount) (0 = no discount, 1 = free) | +| `image` | *string* | ➖ | Price in USD per input image | +| `imageOutput` | *string* | ➖ | Price in USD per output image | +| `imageToken` | *string* | ➖ | Price in USD per image token | +| `inputAudioCache` | *string* | ➖ | Price in USD per cached audio input token | +| `inputCacheRead` | *string* | ➖ | Price in USD per cached input token (read) | +| `inputCacheWrite` | *string* | ➖ | Price per cache-write token, in USD per token. For providers with multiple cache TTLs (e.g. Anthropic), this is the default (5-minute) cache-write rate. | +| `inputCacheWrite1h` | *string* | ➖ | Price per 1-hour cache-write token, in USD per token. Only present for providers that price an extended (1-hour) cache TTL separately, such as Anthropic. | +| `internalReasoning` | *string* | ➖ | Price in USD per internal reasoning token | +| `overrides` | [models.PricingOverride](../models/pricingoverride.mdx)[] | ➖ | Conditional overrides of the base pricing (e.g. long-context or time-based pricing). An entry applies when all of its condition fields (e.g. min_prompt_tokens, or the utc_start/utc_end time window) match the request; among applicable entries, later entries win per key; price keys absent from an entry inherit the base price. The top-level pricing keys always reflect the price that applies under default conditions. | +| `prompt` | *string* | ✅ | Price in USD per token for prompt (input) processing | +| `request` | *string* | ➖ | Price in USD per request | +| `webSearch` | *string* | ➖ | Price in USD per web search | \ No newline at end of file diff --git a/docs/models/rangecapability.mdx b/docs/models/rangecapability.mdx index 15120b650..25a8ec1a4 100644 --- a/docs/models/rangecapability.mdx +++ b/docs/models/rangecapability.mdx @@ -20,6 +20,6 @@ let value: RangeCapability = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `max` | *number* | :heavy_check_mark: | N/A | -| `min` | *number* | :heavy_check_mark: | N/A | -| `type` | *"range"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `max` | *number* | ✅ | N/A | +| `min` | *number* | ✅ | N/A | +| `type` | *"range"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/rankingoptions.mdx b/docs/models/rankingoptions.mdx index cd1104f29..12a31020f 100644 --- a/docs/models/rankingoptions.mdx +++ b/docs/models/rankingoptions.mdx @@ -14,5 +14,5 @@ let value: RankingOptions = {}; | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `ranker` | [models.Ranker](../models/ranker.mdx) | :heavy_minus_sign: | N/A | -| `scoreThreshold` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `ranker` | [models.Ranker](../models/ranker.mdx) | ➖ | N/A | +| `scoreThreshold` | *number* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/rankingsdailyitem.mdx b/docs/models/rankingsdailyitem.mdx index 33935dc73..c6adee665 100644 --- a/docs/models/rankingsdailyitem.mdx +++ b/docs/models/rankingsdailyitem.mdx @@ -18,6 +18,6 @@ let value: RankingsDailyItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `date` | *string* | :heavy_check_mark: | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | -| `modelPermaslug` | *string* | :heavy_check_mark: | Model variant permaslug (e.g. `openai/gpt-4o-2024-05-13`, `openai/gpt-4o-2024-05-13:free`). Non-default variants include a `:variant` suffix and are ranked as their own entry. The reserved value `other` denotes the aggregated row covering every model outside the daily top 50 for that date — always sorted last within its date. | openai/gpt-4o-2024-05-13 | -| `totalTokens` | *string* | :heavy_check_mark: | Sum of `prompt_tokens + completion_tokens` for the day, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file +| `date` | *string* | ✅ | UTC calendar date the row is aggregated over (YYYY-MM-DD). | 2026-05-11 | +| `modelPermaslug` | *string* | ✅ | Model variant permaslug (e.g. `openai/gpt-4o-2024-05-13`, `openai/gpt-4o-2024-05-13:free`). Non-default variants include a `:variant` suffix and are ranked as their own entry. The reserved value `other` denotes the aggregated row covering every model outside the daily top 50 for that date — always sorted last within its date. | openai/gpt-4o-2024-05-13 | +| `totalTokens` | *string* | ✅ | Sum of `prompt_tokens + completion_tokens` for the day, returned as a decimal string so 64-bit values are not truncated. | 12345678 | \ No newline at end of file diff --git a/docs/models/rankingsdailymeta.mdx b/docs/models/rankingsdailymeta.mdx index 0d35ec772..8a6f31cc7 100644 --- a/docs/models/rankingsdailymeta.mdx +++ b/docs/models/rankingsdailymeta.mdx @@ -19,7 +19,7 @@ let value: RankingsDailyMeta = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `asOf` | *string* | :heavy_check_mark: | ISO-8601 timestamp of when the response was generated. Reflects data-freshness because the underlying materialized view continuously ingests upstream events. | 2026-05-12T02:00:00.000Z | -| `endDate` | *string* | :heavy_check_mark: | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | -| `startDate` | *string* | :heavy_check_mark: | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | -| `version` | [models.RankingsDailyMetaVersion](../models/rankingsdailymetaversion.mdx) | :heavy_check_mark: | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file +| `asOf` | *string* | ✅ | ISO-8601 timestamp of when the response was generated. Reflects data-freshness because the underlying materialized view continuously ingests upstream events. | 2026-05-12T02:00:00.000Z | +| `endDate` | *string* | ✅ | Resolved end of the date window (UTC, inclusive). | 2026-05-11 | +| `startDate` | *string* | ✅ | Resolved start of the date window (UTC, inclusive). | 2026-04-12 | +| `version` | [models.RankingsDailyMetaVersion](../models/rankingsdailymetaversion.mdx) | ✅ | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file diff --git a/docs/models/rankingsdailyresponse.mdx b/docs/models/rankingsdailyresponse.mdx index 29a10d817..896d0eae4 100644 --- a/docs/models/rankingsdailyresponse.mdx +++ b/docs/models/rankingsdailyresponse.mdx @@ -33,5 +33,5 @@ let value: RankingsDailyResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.RankingsDailyItem](../models/rankingsdailyitem.mdx)[] | :heavy_check_mark: | Up to 51 rows per day — the top 50 public models by `total_tokens` for each UTC calendar date in the window, plus one aggregated `other` row summing every model outside that top 50 (omitted when the long tail is empty). Rows are sorted by `date` ascending, then by `total_tokens` descending, with `other` pinned last within its date. Ties between real models break alphabetically on `model_permaslug` so the order is stable across requests. | | -| `meta` | [models.RankingsDailyMeta](../models/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `data` | [models.RankingsDailyItem](../models/rankingsdailyitem.mdx)[] | ✅ | Up to 51 rows per day — the top 50 public models by `total_tokens` for each UTC calendar date in the window, plus one aggregated `other` row summing every model outside that top 50 (omitted when the long tail is empty). Rows are sorted by `date` ascending, then by `total_tokens` descending, with `other` pinned last within its date. Ties between real models break alphabetically on `model_permaslug` so the order is stable across requests. | | +| `meta` | [models.RankingsDailyMeta](../models/rankingsdailymeta.mdx) | ✅ | N/A | \{
"as_of": "2026-05-12T02:00:00.000Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/reasoningconfig.mdx b/docs/models/reasoningconfig.mdx index f744f6a0d..e047c4f7e 100644 --- a/docs/models/reasoningconfig.mdx +++ b/docs/models/reasoningconfig.mdx @@ -14,9 +14,9 @@ let value: ReasoningConfig = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `context` | [models.ReasoningContext](../models/reasoningcontext.mdx) | :heavy_minus_sign: | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | -| `effort` | [models.ReasoningEffort](../models/reasoningeffort.mdx) | :heavy_minus_sign: | N/A | medium | -| `mode` | [models.ReasoningMode](../models/reasoningmode.mdx) | :heavy_minus_sign: | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | -| `summary` | [models.ReasoningSummaryVerbosity](../models/reasoningsummaryverbosity.mdx) | :heavy_minus_sign: | N/A | auto | -| `enabled` | *boolean* | :heavy_minus_sign: | N/A | | -| `maxTokens` | *number* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `context` | [models.ReasoningContext](../models/reasoningcontext.mdx) | ➖ | Controls which reasoning is available to the model. `auto` uses the model default (same as omitting); `all_turns` includes reasoning from earlier turns passed in input; `current_turn` limits to the current turn only. Only supported by OpenAI GPT-5.6 and newer. | all_turns | +| `effort` | [models.ReasoningEffort](../models/reasoningeffort.mdx) | ➖ | N/A | medium | +| `mode` | [models.ReasoningMode](../models/reasoningmode.mdx) | ➖ | Selects the reasoning mode. `standard` is the default; `pro` engages deeper reasoning on models that support it, billed at standard token rates. Only supported by OpenAI GPT-5.6 and newer. | standard | +| `summary` | [models.ReasoningSummaryVerbosity](../models/reasoningsummaryverbosity.mdx) | ➖ | N/A | auto | +| `enabled` | *boolean* | ➖ | N/A | | +| `maxTokens` | *number* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningdeltaevent.mdx b/docs/models/reasoningdeltaevent.mdx index 304d9943b..bf72a1981 100644 --- a/docs/models/reasoningdeltaevent.mdx +++ b/docs/models/reasoningdeltaevent.mdx @@ -23,9 +23,9 @@ let value: ReasoningDeltaEvent = { | Field | Type | Required | Description | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.reasoning_text.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `contentIndex` | *number* | ✅ | N/A | +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.reasoning_text.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/reasoningdetailencrypted.mdx b/docs/models/reasoningdetailencrypted.mdx index ddd3862da..2bf582843 100644 --- a/docs/models/reasoningdetailencrypted.mdx +++ b/docs/models/reasoningdetailencrypted.mdx @@ -19,8 +19,8 @@ let value: ReasoningDetailEncrypted = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `data` | *string* | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `index` | *number* | :heavy_minus_sign: | N/A | | -| `type` | *"reasoning.encrypted"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `data` | *string* | ✅ | N/A | | +| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | ➖ | N/A | unknown | +| `id` | *string* | ➖ | N/A | | +| `index` | *number* | ➖ | N/A | | +| `type` | *"reasoning.encrypted"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningdetailservertoolcall.mdx b/docs/models/reasoningdetailservertoolcall.mdx index 62f969f7a..7e2a88b3e 100644 --- a/docs/models/reasoningdetailservertoolcall.mdx +++ b/docs/models/reasoningdetailservertoolcall.mdx @@ -21,11 +21,11 @@ let value: ReasoningDetailServerToolCall = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `arguments` | *string* | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `index` | *number* | :heavy_minus_sign: | N/A | | -| `result` | *string* | :heavy_check_mark: | N/A | | -| `toolCallId` | *string* | :heavy_minus_sign: | N/A | | -| `toolName` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"reasoning.server_tool_call"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `arguments` | *string* | ✅ | N/A | | +| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | ➖ | N/A | unknown | +| `id` | *string* | ➖ | N/A | | +| `index` | *number* | ➖ | N/A | | +| `result` | *string* | ✅ | N/A | | +| `toolCallId` | *string* | ➖ | N/A | | +| `toolName` | *string* | ✅ | N/A | | +| `type` | *"reasoning.server_tool_call"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningdetailsummary.mdx b/docs/models/reasoningdetailsummary.mdx index 226874342..6354b5a39 100644 --- a/docs/models/reasoningdetailsummary.mdx +++ b/docs/models/reasoningdetailsummary.mdx @@ -20,8 +20,8 @@ let value: ReasoningDetailSummary = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `index` | *number* | :heavy_minus_sign: | N/A | | -| `summary` | *string* | :heavy_check_mark: | N/A | | -| `type` | *"reasoning.summary"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | ➖ | N/A | unknown | +| `id` | *string* | ➖ | N/A | | +| `index` | *number* | ➖ | N/A | | +| `summary` | *string* | ✅ | N/A | | +| `type` | *"reasoning.summary"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningdetailtext.mdx b/docs/models/reasoningdetailtext.mdx index e69e16d29..5a6fdaf44 100644 --- a/docs/models/reasoningdetailtext.mdx +++ b/docs/models/reasoningdetailtext.mdx @@ -18,9 +18,9 @@ let value: ReasoningDetailText = { | Field | Type | Required | Description | Example | | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `index` | *number* | :heavy_minus_sign: | N/A | | -| `signature` | *string* | :heavy_minus_sign: | N/A | | -| `text` | *string* | :heavy_minus_sign: | N/A | | -| `type` | *"reasoning.text"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | ➖ | N/A | unknown | +| `id` | *string* | ➖ | N/A | | +| `index` | *number* | ➖ | N/A | | +| `signature` | *string* | ➖ | N/A | | +| `text` | *string* | ➖ | N/A | | +| `type` | *"reasoning.text"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningdoneevent.mdx b/docs/models/reasoningdoneevent.mdx index ba2962f7d..e9bc9749b 100644 --- a/docs/models/reasoningdoneevent.mdx +++ b/docs/models/reasoningdoneevent.mdx @@ -23,9 +23,9 @@ let value: ReasoningDoneEvent = { | Field | Type | Required | Description | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"response.reasoning_text.done"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `contentIndex` | *number* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `text` | *string* | ✅ | N/A | +| `type` | *"response.reasoning_text.done"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/reasoningitem.mdx b/docs/models/reasoningitem.mdx index 40ab7f523..6ea85c2ee 100644 --- a/docs/models/reasoningitem.mdx +++ b/docs/models/reasoningitem.mdx @@ -25,11 +25,11 @@ let value: ReasoningItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | :heavy_minus_sign: | N/A | | -| `encryptedContent` | *string* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | | -| `status` | *models.ReasoningItemStatusUnion* | :heavy_minus_sign: | N/A | | -| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | :heavy_check_mark: | N/A | | -| `type` | [models.ReasoningItemType](../models/reasoningitemtype.mdx) | :heavy_check_mark: | N/A | | -| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | :heavy_minus_sign: | N/A | unknown | -| `signature` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `content` | [models.ReasoningTextContent](../models/reasoningtextcontent.mdx)[] | ➖ | N/A | | +| `encryptedContent` | *string* | ➖ | N/A | | +| `id` | *string* | ✅ | N/A | | +| `status` | *models.ReasoningItemStatusUnion* | ➖ | N/A | | +| `summary` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx)[] | ✅ | N/A | | +| `type` | [models.ReasoningItemType](../models/reasoningitemtype.mdx) | ✅ | N/A | | +| `format` | [models.ReasoningFormat](../models/reasoningformat.mdx) | ➖ | N/A | unknown | +| `signature` | *string* | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningsummarypartaddedevent.mdx b/docs/models/reasoningsummarypartaddedevent.mdx index 581c4a947..c9e6f31cb 100644 --- a/docs/models/reasoningsummarypartaddedevent.mdx +++ b/docs/models/reasoningsummarypartaddedevent.mdx @@ -26,9 +26,9 @@ let value: ReasoningSummaryPartAddedEvent = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `part` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.reasoning_summary_part.added"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | | +| `outputIndex` | *number* | ✅ | N/A | | +| `part` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `summaryIndex` | *number* | ✅ | N/A | | +| `type` | *"response.reasoning_summary_part.added"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningsummarypartdoneevent.mdx b/docs/models/reasoningsummarypartdoneevent.mdx index 195b546bd..46b71e672 100644 --- a/docs/models/reasoningsummarypartdoneevent.mdx +++ b/docs/models/reasoningsummarypartdoneevent.mdx @@ -26,9 +26,9 @@ let value: ReasoningSummaryPartDoneEvent = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `part` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.reasoning_summary_part.done"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | | +| `outputIndex` | *number* | ✅ | N/A | | +| `part` | [models.ReasoningSummaryText](../models/reasoningsummarytext.mdx) | ✅ | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `summaryIndex` | *number* | ✅ | N/A | | +| `type` | *"response.reasoning_summary_part.done"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/reasoningsummarytext.mdx b/docs/models/reasoningsummarytext.mdx index 0339ed751..b4db385ef 100644 --- a/docs/models/reasoningsummarytext.mdx +++ b/docs/models/reasoningsummarytext.mdx @@ -17,5 +17,5 @@ let value: ReasoningSummaryText = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.ReasoningSummaryTextType](../models/reasoningsummarytexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *string* | ✅ | N/A | +| `type` | [models.ReasoningSummaryTextType](../models/reasoningsummarytexttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/reasoningsummarytextdeltaevent.mdx b/docs/models/reasoningsummarytextdeltaevent.mdx index 35b371da8..a266d7b9b 100644 --- a/docs/models/reasoningsummarytextdeltaevent.mdx +++ b/docs/models/reasoningsummarytextdeltaevent.mdx @@ -23,9 +23,9 @@ let value: ReasoningSummaryTextDeltaEvent = { | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.reasoning_summary_text.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `summaryIndex` | *number* | ✅ | N/A | +| `type` | *"response.reasoning_summary_text.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/reasoningsummarytextdoneevent.mdx b/docs/models/reasoningsummarytextdoneevent.mdx index 99b47e4cb..d6f286b51 100644 --- a/docs/models/reasoningsummarytextdoneevent.mdx +++ b/docs/models/reasoningsummarytextdoneevent.mdx @@ -23,9 +23,9 @@ let value: ReasoningSummaryTextDoneEvent = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `summaryIndex` | *number* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"response.reasoning_summary_text.done"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `summaryIndex` | *number* | ✅ | N/A | +| `text` | *string* | ✅ | N/A | +| `type` | *"response.reasoning_summary_text.done"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/reasoningtextcontent.mdx b/docs/models/reasoningtextcontent.mdx index 0459188a5..f7cace9ad 100644 --- a/docs/models/reasoningtextcontent.mdx +++ b/docs/models/reasoningtextcontent.mdx @@ -17,5 +17,5 @@ let value: ReasoningTextContent = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | [models.ReasoningTextContentType](../models/reasoningtextcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `text` | *string* | ✅ | N/A | +| `type` | [models.ReasoningTextContentType](../models/reasoningtextcontenttype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/refusal.mdx b/docs/models/refusal.mdx index 78e6568f6..70eabfceb 100644 --- a/docs/models/refusal.mdx +++ b/docs/models/refusal.mdx @@ -29,7 +29,7 @@ let value: Refusal = { | Field | Type | Required | Description | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.RefusalTopLogprob](../models/refusaltoplogprob.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes` | *number*[] | ✅ | N/A | +| `logprob` | *number* | ✅ | N/A | +| `token` | *string* | ✅ | N/A | +| `topLogprobs` | [models.RefusalTopLogprob](../models/refusaltoplogprob.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/refusaldeltaevent.mdx b/docs/models/refusaldeltaevent.mdx index 2b0f0dd3b..e6c3e56e2 100644 --- a/docs/models/refusaldeltaevent.mdx +++ b/docs/models/refusaldeltaevent.mdx @@ -23,9 +23,9 @@ let value: RefusalDeltaEvent = { | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.refusal.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `contentIndex` | *number* | ✅ | N/A | +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.refusal.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/refusaldoneevent.mdx b/docs/models/refusaldoneevent.mdx index 58c2d8dbd..1c714aa0f 100644 --- a/docs/models/refusaldoneevent.mdx +++ b/docs/models/refusaldoneevent.mdx @@ -23,9 +23,9 @@ let value: RefusalDoneEvent = { | Field | Type | Required | Description | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `refusal` | *string* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.refusal.done"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `contentIndex` | *number* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `refusal` | *string* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.refusal.done"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/refusaltoplogprob.mdx b/docs/models/refusaltoplogprob.mdx index 396776262..9e2336152 100644 --- a/docs/models/refusaltoplogprob.mdx +++ b/docs/models/refusaltoplogprob.mdx @@ -21,6 +21,6 @@ let value: RefusalTopLogprob = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes` | *number*[] | ✅ | N/A | +| `logprob` | *number* | ✅ | N/A | +| `token` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/requestt.mdx b/docs/models/requestt.mdx index b449e05c2..e1279dd38 100644 --- a/docs/models/requestt.mdx +++ b/docs/models/requestt.mdx @@ -20,5 +20,5 @@ let value: RequestT = { | Field | Type | Required | Description | | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `body` | Record\ | :heavy_check_mark: | Request payload for the batch `endpoint`. | -| `customId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `body` | Record\ | ✅ | Request payload for the batch `endpoint`. | +| `customId` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/requesttimeoutresponseerrordata.mdx b/docs/models/requesttimeoutresponseerrordata.mdx index 40b558e78..3d9efd92e 100644 --- a/docs/models/requesttimeoutresponseerrordata.mdx +++ b/docs/models/requesttimeoutresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: RequestTimeoutResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/requireapproval.mdx b/docs/models/requireapproval.mdx index dcdc75db6..be22bbffb 100644 --- a/docs/models/requireapproval.mdx +++ b/docs/models/requireapproval.mdx @@ -14,5 +14,5 @@ let value: RequireApproval = {}; | Field | Type | Required | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `always` | [models.Always](../models/always.mdx) | :heavy_minus_sign: | N/A | -| `never` | [models.Never](../models/never.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `always` | [models.Always](../models/always.mdx) | ➖ | N/A | +| `never` | [models.Never](../models/never.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/rerank.mdx b/docs/models/rerank.mdx index 1ea3c6372..e37e032ec 100644 --- a/docs/models/rerank.mdx +++ b/docs/models/rerank.mdx @@ -28,6 +28,6 @@ let value: Rerank = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `requestCount` | *number* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `requestCount` | *number* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/responsehealingplugin.mdx b/docs/models/responsehealingplugin.mdx index 580ebd6da..a9bfdc875 100644 --- a/docs/models/responsehealingplugin.mdx +++ b/docs/models/responsehealingplugin.mdx @@ -16,5 +16,5 @@ let value: ResponseHealingPlugin = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | -| `id` | *"response-healing"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `enabled` | *boolean* | ➖ | Set to false to disable the response-healing plugin for this request. Defaults to true. | +| `id` | *"response-healing"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/responseoutputtext.mdx b/docs/models/responseoutputtext.mdx index adc4701bf..586598c64 100644 --- a/docs/models/responseoutputtext.mdx +++ b/docs/models/responseoutputtext.mdx @@ -17,7 +17,7 @@ let value: ResponseOutputText = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `annotations` | *models.OpenAIResponsesAnnotation*[] | :heavy_minus_sign: | N/A | -| `logprobs` | [models.Logprob](../models/logprob.mdx)[] | :heavy_minus_sign: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"output_text"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `annotations` | *models.OpenAIResponsesAnnotation*[] | ➖ | N/A | +| `logprobs` | [models.Logprob](../models/logprob.mdx)[] | ➖ | N/A | +| `text` | *string* | ✅ | N/A | +| `type` | *"output_text"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/responseoutputtexttoplogprob.mdx b/docs/models/responseoutputtexttoplogprob.mdx index 3b26446e7..94b3ea20e 100644 --- a/docs/models/responseoutputtexttoplogprob.mdx +++ b/docs/models/responseoutputtexttoplogprob.mdx @@ -21,6 +21,6 @@ let value: ResponseOutputTextTopLogprob = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes` | *number*[] | :heavy_check_mark: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `bytes` | *number*[] | ✅ | N/A | +| `logprob` | *number* | ✅ | N/A | +| `token` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/responsesrequest.mdx b/docs/models/responsesrequest.mdx index da7bb8854..cf90a3429 100644 --- a/docs/models/responsesrequest.mdx +++ b/docs/models/responsesrequest.mdx @@ -16,42 +16,42 @@ let value: ResponsesRequest = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `background` | *boolean* | :heavy_minus_sign: | N/A | | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `debug` | [models.ChatDebugOptions](../models/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | -| `frequencyPenalty` | *number* | :heavy_minus_sign: | N/A | | -| `imageConfig` | Record\ | :heavy_minus_sign: | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | -| `include` | [models.ResponseIncludesEnum](../models/responseincludesenum.mdx)[] | :heavy_minus_sign: | N/A | | -| `input` | *models.InputsUnion* | :heavy_minus_sign: | Input for a response request - can be a string or array of items | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | -| `instructions` | *string* | :heavy_minus_sign: | N/A | | -| `maxOutputTokens` | *number* | :heavy_minus_sign: | N/A | | -| `maxToolCalls` | *number* | :heavy_minus_sign: | Maximum number of server-tool (e.g. `openrouter:web_search`) agent steps the model may take during a request. Defaults to 30, which is also the maximum. Ignored when `stop_server_tools_when` is set. | 30 | -| `metadata` | Record\ | :heavy_minus_sign: | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | -| `modalities` | [models.OutputModalityEnum](../models/outputmodalityenum.mdx)[] | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | -| `model` | *string* | :heavy_minus_sign: | N/A | | -| `models` | *string*[] | :heavy_minus_sign: | N/A | | -| `parallelToolCalls` | *boolean* | :heavy_minus_sign: | N/A | | -| `plugins` | *models.ResponsesRequestPlugin*[] | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `presencePenalty` | *number* | :heavy_minus_sign: | N/A | | -| `previousResponseId` | *any* | :heavy_minus_sign: | Not supported on this proxy. Each response request is independent: no responses are stored, so a previous response cannot be referenced. Requests with a non-null value are rejected with a 400 error. Send the full conversation history in `input` instead. | | -| `prompt` | [models.StoredPromptTemplate](../models/storedprompttemplate.mdx) | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | -| `promptCacheKey` | *string* | :heavy_minus_sign: | N/A | | -| `promptCacheOptions` | [models.PromptCacheOptions](../models/promptcacheoptions.mdx) | :heavy_minus_sign: | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | -| `provider` | [models.ProviderPreferences](../models/providerpreferences.mdx) | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `reasoning` | [models.ReasoningConfig](../models/reasoningconfig.mdx) | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | -| `safetyIdentifier` | *string* | :heavy_minus_sign: | Recommended per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | -| `serviceTier` | [models.ResponsesRequestServiceTier](../models/responsesrequestservicetier.mdx) | :heavy_minus_sign: | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | -| `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | :heavy_minus_sign: | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | -| `store` | *false* | :heavy_minus_sign: | N/A | | -| `stream` | *boolean* | :heavy_minus_sign: | N/A | | -| `temperature` | *number* | :heavy_minus_sign: | N/A | | -| `text` | [models.TextExtendedConfig](../models/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | :heavy_minus_sign: | N/A | auto | -| `tools` | *models.ResponsesRequestToolUnion*[] | :heavy_minus_sign: | N/A | | -| `topK` | *number* | :heavy_minus_sign: | N/A | | -| `topLogprobs` | *number* | :heavy_minus_sign: | N/A | | -| `topP` | *number* | :heavy_minus_sign: | N/A | | -| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `truncation` | [models.OpenAIResponsesTruncation](../models/openairesponsestruncation.mdx) | :heavy_minus_sign: | N/A | auto | -| `user` | *string* | :heavy_minus_sign: | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file +| `background` | *boolean* | ➖ | N/A | | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `debug` | [models.ChatDebugOptions](../models/chatdebugoptions.mdx) | ➖ | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `frequencyPenalty` | *number* | ➖ | N/A | | +| `imageConfig` | Record\ | ➖ | Provider-specific image configuration options. Keys and values vary by model/provider. See https://openrouter.ai/docs/guides/overview/multimodal/image-generation for more details. | \{
"aspect_ratio": "16:9",
"quality": "high"
} | +| `include` | [models.ResponseIncludesEnum](../models/responseincludesenum.mdx)[] | ➖ | N/A | | +| `input` | *models.InputsUnion* | ➖ | Input for a response request - can be a string or array of items | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `instructions` | *string* | ➖ | N/A | | +| `maxOutputTokens` | *number* | ➖ | N/A | | +| `maxToolCalls` | *number* | ➖ | Maximum number of server-tool (e.g. `openrouter:web_search`) agent steps the model may take during a request. Defaults to 30, which is also the maximum. Ignored when `stop_server_tools_when` is set. | 30 | +| `metadata` | Record\ | ➖ | Metadata key-value pairs for the request. Keys must be ≤64 characters and cannot contain brackets. Values must be ≤512 characters. Maximum 16 pairs allowed. | \{
"session_id": "abc-def-ghi",
"user_id": "123"
} | +| `modalities` | [models.OutputModalityEnum](../models/outputmodalityenum.mdx)[] | ➖ | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `model` | *string* | ➖ | N/A | | +| `models` | *string*[] | ➖ | N/A | | +| `parallelToolCalls` | *boolean* | ➖ | N/A | | +| `plugins` | *models.ResponsesRequestPlugin*[] | ➖ | Plugins you want to enable for this request, including their settings. | | +| `presencePenalty` | *number* | ➖ | N/A | | +| `previousResponseId` | *any* | ➖ | Not supported on this proxy. Each response request is independent: no responses are stored, so a previous response cannot be referenced. Requests with a non-null value are rejected with a 400 error. Send the full conversation history in `input` instead. | | +| `prompt` | [models.StoredPromptTemplate](../models/storedprompttemplate.mdx) | ➖ | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `promptCacheKey` | *string* | ➖ | N/A | | +| `promptCacheOptions` | [models.PromptCacheOptions](../models/promptcacheoptions.mdx) | ➖ | Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed breakpoints so only blocks marked with `prompt_cache_breakpoint` are cached. Only supported by OpenAI GPT-5.6 and newer. | \{
"mode": "explicit",
"ttl": "30m"
} | +| `provider` | [models.ProviderPreferences](../models/providerpreferences.mdx) | ➖ | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `reasoning` | [models.ReasoningConfig](../models/reasoningconfig.mdx) | ➖ | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `safetyIdentifier` | *string* | ➖ | Recommended per-end-user identifier for abuse isolation. Use a stable ID, hash, or pseudonym. When a provider requires a user identity, OpenRouter folds it into the hashed identity sent upstream and never forwards it raw. If omitted, requests use an account-level identity, so provider policy blocks can affect the whole account. | user-123 | +| `serviceTier` | [models.ResponsesRequestServiceTier](../models/responsesrequestservicetier.mdx) | ➖ | The service tier to use for processing this request. `fast` is accepted as an alias for `priority`. `ultrafast` prefers ultrafast endpoints and falls back to `priority`, then default endpoints. | | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). When provided, OpenRouter uses it as the sticky routing key, routing all requests in the session to the same provider to maximize prompt cache hits. Also used for observability grouping. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | | +| `stopServerToolsWhen` | *models.StopServerToolsWhenCondition*[] | ➖ | Stop conditions for the server-tool agent loop. Any condition firing halts the loop (OR logic). When set, this overrides `max_tool_calls`. When a condition fires while the model is still emitting tool calls, the pending tool calls are executed and one final turn is made with tool calls disabled so the response ends with a natural-language answer instead of an unfinished tool call. | [
\{
"step_count": 5,
"type": "step_count_is"
},
\{
"max_cost_in_dollars": 0.5,
"type": "max_cost"
}
] | +| `store` | *false* | ➖ | N/A | | +| `stream` | *boolean* | ➖ | N/A | | +| `temperature` | *number* | ➖ | N/A | | +| `text` | [models.TextExtendedConfig](../models/textextendedconfig.mdx) | ➖ | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `toolChoice` | *models.OpenAIResponsesToolChoiceUnion* | ➖ | N/A | auto | +| `tools` | *models.ResponsesRequestToolUnion*[] | ➖ | N/A | | +| `topK` | *number* | ➖ | N/A | | +| `topLogprobs` | *number* | ➖ | N/A | | +| `topP` | *number* | ➖ | N/A | | +| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `truncation` | [models.OpenAIResponsesTruncation](../models/openairesponsestruncation.mdx) | ➖ | N/A | auto | +| `user` | *string* | ➖ | A unique identifier representing your end-user, which helps distinguish between different users of your app. This allows your app to identify specific users in case of abuse reports, preventing your entire app from being affected by the actions of individual users. Maximum of 256 characters. | | \ No newline at end of file diff --git a/docs/models/responsesrequesttoolfunction.mdx b/docs/models/responsesrequesttoolfunction.mdx index d890234c8..e06d2585f 100644 --- a/docs/models/responsesrequesttoolfunction.mdx +++ b/docs/models/responsesrequesttoolfunction.mdx @@ -39,10 +39,10 @@ let value: ResponsesRequestToolFunction = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | *string* | :heavy_minus_sign: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `parameters` | Record\ | :heavy_check_mark: | N/A | | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | | -| `type` | *"function"* | :heavy_check_mark: | N/A | | -| `async` | *boolean* | :heavy_minus_sign: | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | -| `deferLoading` | *boolean* | :heavy_minus_sign: | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file +| `description` | *string* | ➖ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `parameters` | Record\ | ✅ | N/A | | +| `strict` | *boolean* | ➖ | N/A | | +| `type` | *"function"* | ✅ | N/A | | +| `async` | *boolean* | ➖ | Lets the model keep working after calling this tool instead of waiting for its output. The tool is still executed by the client; return the result in a later request as a `function_call_output` with the original `call_id`. Only honored by providers whose Responses API supports async tools; ignored elsewhere. | true | +| `deferLoading` | *boolean* | ➖ | Withhold this tool from the model until `openrouter:tool_search` finds it. Requires the tool search server tool; at least one tool must remain non-deferred. | true | \ No newline at end of file diff --git a/docs/models/responsesstreamingresponse.mdx b/docs/models/responsesstreamingresponse.mdx index aafa10610..2282e150d 100644 --- a/docs/models/responsesstreamingresponse.mdx +++ b/docs/models/responsesstreamingresponse.mdx @@ -24,4 +24,4 @@ let value: ResponsesStreamingResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `data` | *models.StreamEvents* | :heavy_check_mark: | Union of all possible event types emitted during response streaming | \{
"response": \{
"completed_at": null,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "in_progress",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null
},
"sequence_number": 0,
"type": "response.created"
} | \ No newline at end of file +| `data` | *models.StreamEvents* | ✅ | Union of all possible event types emitted during response streaming | \{
"response": \{
"completed_at": null,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "in_progress",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null
},
"sequence_number": 0,
"type": "response.created"
} | \ No newline at end of file diff --git a/docs/models/result.mdx b/docs/models/result.mdx index 26640c925..8711b1f7d 100644 --- a/docs/models/result.mdx +++ b/docs/models/result.mdx @@ -58,7 +58,7 @@ let value: Result = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `customId` | *string* | :heavy_check_mark: | N/A | -| `error` | [models.ResultError](../models/resulterror.mdx) | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `response` | [models.BatchObjectResponse](../models/batchobjectresponse.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `customId` | *string* | ✅ | N/A | +| `error` | [models.ResultError](../models/resulterror.mdx) | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `response` | [models.BatchObjectResponse](../models/batchobjectresponse.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/resulterror.mdx b/docs/models/resulterror.mdx index 46ae380dc..0883f1e6b 100644 --- a/docs/models/resulterror.mdx +++ b/docs/models/resulterror.mdx @@ -18,7 +18,7 @@ let value: ResultError = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `errorType` | [models.ApiErrorType](../models/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `message` | *string* | :heavy_check_mark: | N/A | | -| `param` | *string* | :heavy_check_mark: | N/A | | -| `type` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `errorType` | [models.ApiErrorType](../models/apierrortype.mdx) | ➖ | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `message` | *string* | ✅ | N/A | | +| `param` | *string* | ✅ | N/A | | +| `type` | *string* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/routerattempt.mdx b/docs/models/routerattempt.mdx index 2f419ee4a..cfb86eac6 100644 --- a/docs/models/routerattempt.mdx +++ b/docs/models/routerattempt.mdx @@ -18,6 +18,6 @@ let value: RouterAttempt = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | -| `provider` | *string* | :heavy_check_mark: | N/A | -| `status` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `model` | *string* | ✅ | N/A | +| `provider` | *string* | ✅ | N/A | +| `status` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/routerparams.mdx b/docs/models/routerparams.mdx index bd5316671..af05ab4b1 100644 --- a/docs/models/routerparams.mdx +++ b/docs/models/routerparams.mdx @@ -14,7 +14,7 @@ let value: RouterParams = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `qualityFloor` | *number* | :heavy_minus_sign: | N/A | | -| `throughputFloor` | *number* | :heavy_minus_sign: | N/A | | -| `versionGroup` | *string* | :heavy_minus_sign: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file +| `qualityFloor` | *number* | ➖ | N/A | | +| `throughputFloor` | *number* | ➖ | N/A | | +| `versionGroup` | *string* | ➖ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | \ No newline at end of file diff --git a/docs/models/rule.mdx b/docs/models/rule.mdx index d648f9009..5f3fe4af5 100644 --- a/docs/models/rule.mdx +++ b/docs/models/rule.mdx @@ -17,6 +17,6 @@ let value: Rule = { | Field | Type | Required | Description | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `field` | [models.Field](../models/field.mdx) | :heavy_check_mark: | N/A | -| `operator` | [models.Operator](../models/operator.mdx) | :heavy_check_mark: | N/A | -| `value` | *models.ObservabilityFilterRuleGroupValue* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `field` | [models.Field](../models/field.mdx) | ✅ | N/A | +| `operator` | [models.Operator](../models/operator.mdx) | ✅ | N/A | +| `value` | *models.ObservabilityFilterRuleGroupValue* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/scimgroup.mdx b/docs/models/scimgroup.mdx index d6b892786..8f2303e05 100644 --- a/docs/models/scimgroup.mdx +++ b/docs/models/scimgroup.mdx @@ -21,9 +21,9 @@ let value: ScimGroup = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `displayName` | *string* | :heavy_check_mark: | N/A | -| `externalId` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `organizationId` | *string* | :heavy_check_mark: | N/A | -| `updatedAt` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `createdAt` | *string* | ✅ | N/A | +| `displayName` | *string* | ✅ | N/A | +| `externalId` | *string* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `organizationId` | *string* | ✅ | N/A | +| `updatedAt` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/scimgroupmapping.mdx b/docs/models/scimgroupmapping.mdx index 66d93ea69..37c0721ad 100644 --- a/docs/models/scimgroupmapping.mdx +++ b/docs/models/scimgroupmapping.mdx @@ -22,10 +22,10 @@ let value: ScimGroupMapping = { | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `createdAt` | *string* | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `organizationId` | *string* | :heavy_check_mark: | N/A | -| `role` | [models.ScimGroupMappingRole](../models/scimgroupmappingrole.mdx) | :heavy_check_mark: | N/A | -| `scimGroupId` | *string* | :heavy_check_mark: | N/A | -| `updatedAt` | *string* | :heavy_check_mark: | N/A | -| `workspaceId` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `createdAt` | *string* | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `organizationId` | *string* | ✅ | N/A | +| `role` | [models.ScimGroupMappingRole](../models/scimgroupmappingrole.mdx) | ✅ | N/A | +| `scimGroupId` | *string* | ✅ | N/A | +| `updatedAt` | *string* | ✅ | N/A | +| `workspaceId` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/scimsyncjob.mdx b/docs/models/scimsyncjob.mdx index 585ca324a..41a349d38 100644 --- a/docs/models/scimsyncjob.mdx +++ b/docs/models/scimsyncjob.mdx @@ -23,11 +23,11 @@ let value: ScimSyncJob = { | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `createdAt` | *string* | :heavy_check_mark: | Time when the sync job was created. | -| `deletedGroups` | *number* | :heavy_check_mark: | Number of groups deleted, when the job completed successfully. | -| `errorMessage` | *string* | :heavy_check_mark: | Stable error message when the job failed. | -| `finishedAt` | *string* | :heavy_check_mark: | Time when synchronization finished. | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the sync job. | -| `startedAt` | *string* | :heavy_check_mark: | Time when synchronization started. | -| `status` | [models.ScimSyncJobStatus](../models/scimsyncjobstatus.mdx) | :heavy_check_mark: | Current status of the sync job: queued, running, succeeded, or failed. | -| `syncedGroups` | *number* | :heavy_check_mark: | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file +| `createdAt` | *string* | ✅ | Time when the sync job was created. | +| `deletedGroups` | *number* | ✅ | Number of groups deleted, when the job completed successfully. | +| `errorMessage` | *string* | ✅ | Stable error message when the job failed. | +| `finishedAt` | *string* | ✅ | Time when synchronization finished. | +| `id` | *string* | ✅ | Unique identifier for the sync job. | +| `startedAt` | *string* | ✅ | Time when synchronization started. | +| `status` | [models.ScimSyncJobStatus](../models/scimsyncjobstatus.mdx) | ✅ | Current status of the sync job: queued, running, succeeded, or failed. | +| `syncedGroups` | *number* | ✅ | Number of groups synchronized, when the job completed successfully. | \ No newline at end of file diff --git a/docs/models/searchmodelsservertoolconfig.mdx b/docs/models/searchmodelsservertoolconfig.mdx index 4bdb42b46..793ddc6ab 100644 --- a/docs/models/searchmodelsservertoolconfig.mdx +++ b/docs/models/searchmodelsservertoolconfig.mdx @@ -16,4 +16,4 @@ let value: SearchModelsServerToolConfig = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file +| `maxResults` | *number* | ➖ | Maximum number of models to return. Defaults to 5, max 20. | 5 | \ No newline at end of file diff --git a/docs/models/searchmodelsservertoolopenrouter.mdx b/docs/models/searchmodelsservertoolopenrouter.mdx index ca140b034..5ad75e958 100644 --- a/docs/models/searchmodelsservertoolopenrouter.mdx +++ b/docs/models/searchmodelsservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: SearchModelsServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `type` | [models.SearchModelsServerToolOpenRouterType](../models/searchmodelsservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.SearchModelsServerToolConfig](../models/searchmodelsservertoolconfig.mdx) | ➖ | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `type` | [models.SearchModelsServerToolOpenRouterType](../models/searchmodelsservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/security.mdx b/docs/models/security.mdx index efdcc3db8..181327323 100644 --- a/docs/models/security.mdx +++ b/docs/models/security.mdx @@ -14,4 +14,4 @@ let value: Security = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `apiKey` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `apiKey` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/servertool.mdx b/docs/models/servertool.mdx index 42075b0c3..833ea1415 100644 --- a/docs/models/servertool.mdx +++ b/docs/models/servertool.mdx @@ -57,18 +57,18 @@ let value: ServerTool = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aliases` | [models.ServerToolInputName](../models/servertoolinputname.mdx)[] | :heavy_check_mark: | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | -| `defaultEngine` | *string* | :heavy_check_mark: | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | -| `docsUrl` | *string* | :heavy_check_mark: | N/A | | -| `engines` | [models.ServerToolEngine](../models/servertoolengine.mdx)[] | :heavy_check_mark: | N/A | | -| `fallbackEngine` | *string* | :heavy_check_mark: | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | -| `id` | *string* | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `inputSchema` | Record\ | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `name` | *string* | :heavy_check_mark: | N/A | Web search | -| `nativeSupport` | [models.ServerToolNativeSupport](../models/servertoolnativesupport.mdx) | :heavy_check_mark: | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | -| `outputSchema` | Record\ | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `parametersSchema` | Record\ | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `status` | [models.ServerToolStatus](../models/servertoolstatus.mdx) | :heavy_check_mark: | N/A | active | -| `summary` | *string* | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | -| `supportedApiFormats` | [models.ServerToolSupportedApiFormat](../models/servertoolsupportedapiformat.mdx)[] | :heavy_check_mark: | N/A | | -| `toolDescription` | *string* | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file +| `aliases` | [models.ServerToolInputName](../models/servertoolinputname.mdx)[] | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | +| `defaultEngine` | *string* | ✅ | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | +| `docsUrl` | *string* | ✅ | N/A | | +| `engines` | [models.ServerToolEngine](../models/servertoolengine.mdx)[] | ✅ | N/A | | +| `fallbackEngine` | *string* | ✅ | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | +| `id` | *string* | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `inputSchema` | Record\ | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `name` | *string* | ✅ | N/A | Web search | +| `nativeSupport` | [models.ServerToolNativeSupport](../models/servertoolnativesupport.mdx) | ✅ | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | +| `outputSchema` | Record\ | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `parametersSchema` | Record\ | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `status` | [models.ServerToolStatus](../models/servertoolstatus.mdx) | ✅ | N/A | active | +| `summary` | *string* | ✅ | One sentence for cards and search results; never sent to a model | | +| `supportedApiFormats` | [models.ServerToolSupportedApiFormat](../models/servertoolsupportedapiformat.mdx)[] | ✅ | N/A | | +| `toolDescription` | *string* | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/models/servertooldetails.mdx b/docs/models/servertooldetails.mdx index a1d250149..28363130c 100644 --- a/docs/models/servertooldetails.mdx +++ b/docs/models/servertooldetails.mdx @@ -61,18 +61,18 @@ let value: ServerToolDetails = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aliases` | [models.ServerToolInputName](../models/servertoolinputname.mdx)[] | :heavy_check_mark: | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | -| `defaultEngine` | *string* | :heavy_check_mark: | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | -| `docsUrl` | *string* | :heavy_check_mark: | N/A | | -| `engines` | [models.ServerToolEngine](../models/servertoolengine.mdx)[] | :heavy_check_mark: | N/A | | -| `fallbackEngine` | *string* | :heavy_check_mark: | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | -| `id` | *string* | :heavy_check_mark: | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | -| `inputSchema` | Record\ | :heavy_check_mark: | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | -| `name` | *string* | :heavy_check_mark: | N/A | Web search | -| `nativeSupport` | [models.NativeSupport](../models/nativesupport.mdx) | :heavy_check_mark: | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | -| `outputSchema` | Record\ | :heavy_check_mark: | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | -| `parametersSchema` | Record\ | :heavy_check_mark: | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | -| `status` | [models.ServerToolDetailsStatus](../models/servertooldetailsstatus.mdx) | :heavy_check_mark: | N/A | active | -| `summary` | *string* | :heavy_check_mark: | One sentence for cards and search results; never sent to a model | | -| `supportedApiFormats` | [models.ServerToolDetailsSupportedApiFormat](../models/servertooldetailssupportedapiformat.mdx)[] | :heavy_check_mark: | N/A | | -| `toolDescription` | *string* | :heavy_check_mark: | The description sent upstream as the function tool description | | \ No newline at end of file +| `aliases` | [models.ServerToolInputName](../models/servertoolinputname.mdx)[] | ✅ | Every spelling accepted in `tools[].type` for this tool, including the canonical `id`, and what the call surfaces as under each | | +| `defaultEngine` | *string* | ✅ | The engine a request without `parameters.engine` (or with `engine: "auto"`) runs on; `native` applies where the endpoint runs the tool itself, otherwise `fallback_engine`. A request pinned to a data region skips either engine when its `data_regions` does not list that region. Null for a tool without an engine parameter | native | +| `docsUrl` | *string* | ✅ | N/A | | +| `engines` | [models.ServerToolEngine](../models/servertoolengine.mdx)[] | ✅ | N/A | | +| `fallbackEngine` | *string* | ✅ | The engine an unpinned request runs on when `default_engine` is `native` and the endpoint does not run the tool itself; null when there is no fallback | exa | +| `id` | *string* | ✅ | Canonical `openrouter:*` name; the stable `tools[].type` on every API format in `supported_api_formats` | openrouter:web_search | +| `inputSchema` | Record\ | ✅ | JSON Schema of the arguments the model emits when calling the tool | \{
"properties": \{},
"type": "object"
} | +| `name` | *string* | ✅ | N/A | Web search | +| `nativeSupport` | [models.NativeSupport](../models/nativesupport.mdx) | ✅ | Endpoints whose provider runs this tool itself during inference. Zero for tools no provider runs natively. | \{
"endpoint_count": 18,
"model_count": 12
} | +| `outputSchema` | Record\ | ✅ | JSON Schema of the result returned to the model; null when undeclared | \{
"properties": \{},
"type": "object"
} | +| `parametersSchema` | Record\ | ✅ | JSON Schema for the caller-side `tools[].parameters` object | \{
"properties": \{},
"type": "object"
} | +| `status` | [models.ServerToolDetailsStatus](../models/servertooldetailsstatus.mdx) | ✅ | N/A | active | +| `summary` | *string* | ✅ | One sentence for cards and search results; never sent to a model | | +| `supportedApiFormats` | [models.ServerToolDetailsSupportedApiFormat](../models/servertooldetailssupportedapiformat.mdx)[] | ✅ | N/A | | +| `toolDescription` | *string* | ✅ | The description sent upstream as the function tool description | | \ No newline at end of file diff --git a/docs/models/servertoolengine.mdx b/docs/models/servertoolengine.mdx index aaa4f6d5c..245d3a9ca 100644 --- a/docs/models/servertoolengine.mdx +++ b/docs/models/servertoolengine.mdx @@ -34,12 +34,12 @@ let value: ServerToolEngine = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `byok` | [models.BYOK](../models/byok.mdx) | :heavy_check_mark: | Whether the engine needs the caller's own key, saved in plugin settings: `required` (OpenRouter holds none), `optional` (OpenRouter's key is used unless the caller saved one), or `none` | none | -| `dataRegions` | [models.ServerToolEngineDataRegion](../models/servertoolenginedataregion.mdx)[] | :heavy_check_mark: | The data regions whose requests this engine serves without leaving the region. A request pinned to a region can only use engines that list it; `global` is always listed. | [
"global",
"us"
] | -| `defaultMode` | *string* | :heavy_check_mark: | The `parameters.mode` a request without one runs and bills as; null for engines without modes. The `pricing[]` row with this `mode` is what an unmoded request bills | auto | -| `executedBy` | [models.ServerToolExecutedBy](../models/servertoolexecutedby.mdx) | :heavy_check_mark: | Who runs the tool call: the model provider during inference (`provider`), OpenRouter (`openrouter`), or the caller's application after the call is returned (`client`). | openrouter | -| `id` | *string* | :heavy_check_mark: | The `parameters.engine` value that selects this engine; null for the single engine of a tool without an engine parameter | exa | -| `name` | *string* | :heavy_check_mark: | N/A | Exa | -| `pricing` | [models.ServerToolPrice](../models/servertoolprice.mdx)[] | :heavy_check_mark: | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | -| `pricingDocUrl` | *string* | :heavy_check_mark: | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | -| `pricingSource` | [models.PricingSource](../models/pricingsource.mdx) | :heavy_check_mark: | Who bills the engine's calls beyond the model's tokens: `openrouter` (the `pricing` rows, from the caller's credits), `provider` (a per-call tool fee from the model's provider on the inference call, at its own rates), `byok` (the engine's vendor, against the caller's own key), or `none` (no charge) | openrouter | \ No newline at end of file +| `byok` | [models.BYOK](../models/byok.mdx) | ✅ | Whether the engine needs the caller's own key, saved in plugin settings: `required` (OpenRouter holds none), `optional` (OpenRouter's key is used unless the caller saved one), or `none` | none | +| `dataRegions` | [models.ServerToolEngineDataRegion](../models/servertoolenginedataregion.mdx)[] | ✅ | The data regions whose requests this engine serves without leaving the region. A request pinned to a region can only use engines that list it; `global` is always listed. | [
"global",
"us"
] | +| `defaultMode` | *string* | ✅ | The `parameters.mode` a request without one runs and bills as; null for engines without modes. The `pricing[]` row with this `mode` is what an unmoded request bills | auto | +| `executedBy` | [models.ServerToolExecutedBy](../models/servertoolexecutedby.mdx) | ✅ | Who runs the tool call: the model provider during inference (`provider`), OpenRouter (`openrouter`), or the caller's application after the call is returned (`client`). | openrouter | +| `id` | *string* | ✅ | The `parameters.engine` value that selects this engine; null for the single engine of a tool without an engine parameter | exa | +| `name` | *string* | ✅ | N/A | Exa | +| `pricing` | [models.ServerToolPrice](../models/servertoolprice.mdx)[] | ✅ | The rows OpenRouter bills; non-empty exactly when `pricing_source` is `openrouter` | | +| `pricingDocUrl` | *string* | ✅ | Where the rates are documented when `pricing_source` is `provider` or `byok`; null otherwise | null | +| `pricingSource` | [models.PricingSource](../models/pricingsource.mdx) | ✅ | Who bills the engine's calls beyond the model's tokens: `openrouter` (the `pricing` rows, from the caller's credits), `provider` (a per-call tool fee from the model's provider on the inference call, at its own rates), `byok` (the engine's vendor, against the caller's own key), or `none` (no charge) | openrouter | \ No newline at end of file diff --git a/docs/models/servertoolinputname.mdx b/docs/models/servertoolinputname.mdx index 333942c08..c249197c7 100644 --- a/docs/models/servertoolinputname.mdx +++ b/docs/models/servertoolinputname.mdx @@ -23,6 +23,6 @@ let value: ServerToolInputName = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiFormats` | [models.ServerToolInputNameApiFormat](../models/servertoolinputnameapiformat.mdx)[] | :heavy_check_mark: | API formats that accept this spelling in `tools[].type` | | -| `outputNames` | [models.ServerToolOutputName](../models/servertooloutputname.mdx)[] | :heavy_check_mark: | What the call surfaces as on each accepting API format when requested under this spelling; a format is absent when the call is not visible to the caller | | -| `type` | *string* | :heavy_check_mark: | N/A | web_search_20250305 | \ No newline at end of file +| `apiFormats` | [models.ServerToolInputNameApiFormat](../models/servertoolinputnameapiformat.mdx)[] | ✅ | API formats that accept this spelling in `tools[].type` | | +| `outputNames` | [models.ServerToolOutputName](../models/servertooloutputname.mdx)[] | ✅ | What the call surfaces as on each accepting API format when requested under this spelling; a format is absent when the call is not visible to the caller | | +| `type` | *string* | ✅ | N/A | web_search_20250305 | \ No newline at end of file diff --git a/docs/models/servertoolnativemodel.mdx b/docs/models/servertoolnativemodel.mdx index 12cf7ecac..7a31a9a0f 100644 --- a/docs/models/servertoolnativemodel.mdx +++ b/docs/models/servertoolnativemodel.mdx @@ -20,5 +20,5 @@ let value: ServerToolNativeModel = { | Field | Type | Required | Description | Example | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- | -| `providers` | *string*[] | :heavy_check_mark: | N/A | [
"Anthropic",
"Google"
] | -| `slug` | *string* | :heavy_check_mark: | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file +| `providers` | *string*[] | ✅ | N/A | [
"Anthropic",
"Google"
] | +| `slug` | *string* | ✅ | N/A | anthropic/claude-4.5-sonnet | \ No newline at end of file diff --git a/docs/models/servertoolnativesupport.mdx b/docs/models/servertoolnativesupport.mdx index 4c6454276..7c0211799 100644 --- a/docs/models/servertoolnativesupport.mdx +++ b/docs/models/servertoolnativesupport.mdx @@ -19,5 +19,5 @@ let value: ServerToolNativeSupport = { | Field | Type | Required | Description | Example | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `endpointCount` | *number* | :heavy_check_mark: | N/A | 18 | -| `modelCount` | *number* | :heavy_check_mark: | N/A | 12 | \ No newline at end of file +| `endpointCount` | *number* | ✅ | N/A | 18 | +| `modelCount` | *number* | ✅ | N/A | 12 | \ No newline at end of file diff --git a/docs/models/servertooloutputname.mdx b/docs/models/servertooloutputname.mdx index 7966c17c9..cac8bad5b 100644 --- a/docs/models/servertooloutputname.mdx +++ b/docs/models/servertooloutputname.mdx @@ -17,6 +17,6 @@ let value: ServerToolOutputName = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `apiFormat` | [models.ServerToolOutputNameApiFormat](../models/servertooloutputnameapiformat.mdx) | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_minus_sign: | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | -| `type` | *string* | :heavy_check_mark: | Output item `type` on Responses, content block `type` on Anthropic Messages, `reasoning_details[].type` on Chat Completions | web_search_call | \ No newline at end of file +| `apiFormat` | [models.ServerToolOutputNameApiFormat](../models/servertooloutputnameapiformat.mdx) | ✅ | N/A | | +| `name` | *string* | ➖ | Anthropic Messages `server_tool_use` block `name`, when the call surfaces as one | web_search | +| `type` | *string* | ✅ | Output item `type` on Responses, content block `type` on Anthropic Messages, `reasoning_details[].type` on Chat Completions | web_search_call | \ No newline at end of file diff --git a/docs/models/servertoolprice.mdx b/docs/models/servertoolprice.mdx index f9ef474c6..8866c28f2 100644 --- a/docs/models/servertoolprice.mdx +++ b/docs/models/servertoolprice.mdx @@ -19,7 +19,7 @@ let value: ServerToolPrice = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `maxUnitsPerCall` | *number* | :heavy_check_mark: | N/A | | -| `mode` | *string* | :heavy_check_mark: | The `parameters.mode` this price applies to; null for prices that do not depend on the mode. A request bills exactly one `request` row | auto | -| `price` | *string* | :heavy_check_mark: | USD per unit, as a decimal string | 0.007 | -| `unit` | *string* | :heavy_check_mark: | N/A | request | \ No newline at end of file +| `maxUnitsPerCall` | *number* | ✅ | N/A | | +| `mode` | *string* | ✅ | The `parameters.mode` this price applies to; null for prices that do not depend on the mode. A request bills exactly one `request` row | auto | +| `price` | *string* | ✅ | USD per unit, as a decimal string | 0.007 | +| `unit` | *string* | ✅ | N/A | request | \ No newline at end of file diff --git a/docs/models/servertoolusedetails.mdx b/docs/models/servertoolusedetails.mdx index 3849b27e3..acfb2e3f4 100644 --- a/docs/models/servertoolusedetails.mdx +++ b/docs/models/servertoolusedetails.mdx @@ -16,6 +16,6 @@ let value: ServerToolUseDetails = {}; | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `toolCallsExecuted` | *number* | :heavy_minus_sign: | Number of OpenRouter server tool calls that executed and produced a result. | -| `toolCallsRequested` | *number* | :heavy_minus_sign: | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | -| `webSearchRequests` | *number* | :heavy_minus_sign: | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file +| `toolCallsExecuted` | *number* | ➖ | Number of OpenRouter server tool calls that executed and produced a result. | +| `toolCallsRequested` | *number* | ➖ | Total number of OpenRouter server-orchestrated tool calls the model requested, across all tool types. Provider-native tools (e.g. native web search) are not counted here. | +| `webSearchRequests` | *number* | ➖ | Number of web searches performed by server-side tools. For server-orchestrated tool calls a web search is also counted in tool_calls_requested; provider-native web search may report web_search_requests only. Do not sum the two. | \ No newline at end of file diff --git a/docs/models/serviceunavailableresponseerrordata.mdx b/docs/models/serviceunavailableresponseerrordata.mdx index 2f9604fb3..dcdc14ef0 100644 --- a/docs/models/serviceunavailableresponseerrordata.mdx +++ b/docs/models/serviceunavailableresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: ServiceUnavailableResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/sessioncostitem.mdx b/docs/models/sessioncostitem.mdx index 73aa8591a..ca2faec78 100644 --- a/docs/models/sessioncostitem.mdx +++ b/docs/models/sessioncostitem.mdx @@ -20,8 +20,8 @@ let value: SessionCostItem = { | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `appName` | *string* | :heavy_check_mark: | Published harness display label. | Hermes Agent | -| `appSlug` | *string* | :heavy_check_mark: | Stable public slug of the harness. | hermes-agent | -| `medianSessionCostUsd` | *number* | :heavy_check_mark: | Median USD spend per sampled session. | 1.74 | -| `modelPermaslug` | *string* | :heavy_check_mark: | Exact model permaslug. | anthropic/claude-4.8-opus | -| `turnRange` | [models.TurnRange](../models/turnrange.mdx) | :heavy_check_mark: | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file +| `appName` | *string* | ✅ | Published harness display label. | Hermes Agent | +| `appSlug` | *string* | ✅ | Stable public slug of the harness. | hermes-agent | +| `medianSessionCostUsd` | *number* | ✅ | Median USD spend per sampled session. | 1.74 | +| `modelPermaslug` | *string* | ✅ | Exact model permaslug. | anthropic/claude-4.8-opus | +| `turnRange` | [models.TurnRange](../models/turnrange.mdx) | ✅ | Inclusive session turn-count range. | 10-49-turns | \ No newline at end of file diff --git a/docs/models/sessioncostmeta.mdx b/docs/models/sessioncostmeta.mdx index 78746194d..bf2921b01 100644 --- a/docs/models/sessioncostmeta.mdx +++ b/docs/models/sessioncostmeta.mdx @@ -19,7 +19,7 @@ let value: SessionCostMeta = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `asOf` | *string* | :heavy_check_mark: | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | -| `version` | [models.SessionCostMetaVersion](../models/sessioncostmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | -| `windowDays` | *number* | :heavy_check_mark: | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | -| `windowEndDate` | *string* | :heavy_check_mark: | UTC date of the final day in the session sample window, or null when no snapshot is published. | 2026-05-11 | \ No newline at end of file +| `asOf` | *string* | ✅ | ISO-8601 timestamp when the response was generated. | 2026-05-12T02:00:00.000Z | +| `version` | [models.SessionCostMetaVersion](../models/sessioncostmetaversion.mdx) | ✅ | Dataset version. | | +| `windowDays` | *number* | ✅ | Number of days in the weekly session sample window, or null when no snapshot is published. | 30 | +| `windowEndDate` | *string* | ✅ | UTC date of the final day in the session sample window, or null when no snapshot is published. | 2026-05-11 | \ No newline at end of file diff --git a/docs/models/sessioncostresponse.mdx b/docs/models/sessioncostresponse.mdx index 3f508ddd2..021c41917 100644 --- a/docs/models/sessioncostresponse.mdx +++ b/docs/models/sessioncostresponse.mdx @@ -22,5 +22,5 @@ let value: SessionCostResponse = { | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `data` | [models.SessionCostItem](../models/sessioncostitem.mdx)[] | :heavy_check_mark: | N/A | -| `meta` | [models.SessionCostMeta](../models/sessioncostmeta.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.SessionCostItem](../models/sessioncostitem.mdx)[] | ✅ | N/A | +| `meta` | [models.SessionCostMeta](../models/sessioncostmeta.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/shellcallitem.mdx b/docs/models/shellcallitem.mdx index 6ac87eecc..ea99036fc 100644 --- a/docs/models/shellcallitem.mdx +++ b/docs/models/shellcallitem.mdx @@ -25,10 +25,10 @@ let value: ShellCallItem = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `action` | [models.ShellCallItemAction](../models/shellcallitemaction.mdx) | :heavy_check_mark: | N/A | | -| `arguments` | *string* | :heavy_minus_sign: | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `environment` | *any* | :heavy_minus_sign: | N/A | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.ShellCallItemType](../models/shellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `action` | [models.ShellCallItemAction](../models/shellcallitemaction.mdx) | ✅ | N/A | | +| `arguments` | *string* | ➖ | The raw tool-call arguments string as emitted by the model. Echo back unchanged when replaying history; used verbatim to preserve provider prompt-cache prefixes. | | +| `callId` | *string* | ✅ | N/A | | +| `environment` | *any* | ➖ | N/A | | +| `id` | *string* | ➖ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [models.ShellCallItemType](../models/shellcallitemtype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/shellcallitemaction.mdx b/docs/models/shellcallitemaction.mdx index f13b9e8e3..51e9d206c 100644 --- a/docs/models/shellcallitemaction.mdx +++ b/docs/models/shellcallitemaction.mdx @@ -16,6 +16,6 @@ let value: ShellCallItemAction = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `commands` | *string*[] | :heavy_check_mark: | N/A | -| `maxOutputLength` | *number* | :heavy_minus_sign: | N/A | -| `timeoutMs` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `commands` | *string*[] | ✅ | N/A | +| `maxOutputLength` | *number* | ➖ | N/A | +| `timeoutMs` | *number* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/shellcalloutputcontent.mdx b/docs/models/shellcalloutputcontent.mdx index a3a2d235d..5dabe9077 100644 --- a/docs/models/shellcalloutputcontent.mdx +++ b/docs/models/shellcalloutputcontent.mdx @@ -23,7 +23,7 @@ let value: ShellCallOutputContent = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `outcome` | *models.Outcome* | :heavy_check_mark: | N/A | | -| `stderr` | *string* | :heavy_check_mark: | N/A | | -| `stdout` | *string* | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"outcome": \{
"exit_code": 0,
"type": "exit"
},
"stderr": "",
"stdout": "total 0\n"
} | \ No newline at end of file +| `outcome` | *models.Outcome* | ✅ | N/A | | +| `stderr` | *string* | ✅ | N/A | | +| `stdout` | *string* | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"outcome": \{
"exit_code": 0,
"type": "exit"
},
"stderr": "",
"stdout": "total 0\n"
} | \ No newline at end of file diff --git a/docs/models/shellcalloutputitem.mdx b/docs/models/shellcalloutputitem.mdx index 44bcf0e01..1bf22139c 100644 --- a/docs/models/shellcalloutputitem.mdx +++ b/docs/models/shellcalloutputitem.mdx @@ -29,12 +29,12 @@ let value: ShellCallOutputItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `callId` | *string* | :heavy_check_mark: | N/A | | -| `containerId` | *string* | :heavy_minus_sign: | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | -| `error` | *string* | :heavy_minus_sign: | The error message when the sandbox call failed before producing a result, as echoed from a failed `shell_call_output` emission. | | -| `files` | [models.ShellCallOutputItemFile](../models/shellcalloutputitemfile.mdx)[] | :heavy_minus_sign: | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | -| `id` | *string* | :heavy_minus_sign: | N/A | | -| `maxOutputLength` | *number* | :heavy_minus_sign: | N/A | | -| `output` | [models.ShellCallOutputContent](../models/shellcalloutputcontent.mdx)[] | :heavy_check_mark: | N/A | | -| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `type` | [models.ShellCallOutputItemTypeShellCallOutput](../models/shellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `callId` | *string* | ✅ | N/A | | +| `containerId` | *string* | ➖ | The canonical container id the command ran under — the `{container_id}` for the Container Files API, reusable as a `container_reference` in later requests. Present on every sandbox-executed call, even when no files changed. | | +| `error` | *string* | ➖ | The error message when the sandbox call failed before producing a result, as echoed from a failed `shell_call_output` emission. | | +| `files` | [models.ShellCallOutputItemFile](../models/shellcalloutputitemfile.mdx)[] | ➖ | Citations for the files the sandbox command created or modified, most-recently-touched first (at most 10). Retrieve them via the Container Files API. | | +| `id` | *string* | ➖ | N/A | | +| `maxOutputLength` | *number* | ➖ | N/A | | +| `output` | [models.ShellCallOutputContent](../models/shellcalloutputcontent.mdx)[] | ✅ | N/A | | +| `status` | [models.ToolCallStatus](../models/toolcallstatus.mdx) | ➖ | N/A | completed | +| `type` | [models.ShellCallOutputItemTypeShellCallOutput](../models/shellcalloutputitemtypeshellcalloutput.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/shellcalloutputitemfile.mdx b/docs/models/shellcalloutputitemfile.mdx index d9fc791ff..c8bb501c3 100644 --- a/docs/models/shellcalloutputitemfile.mdx +++ b/docs/models/shellcalloutputitemfile.mdx @@ -21,9 +21,9 @@ let value: ShellCallOutputItemFile = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `containerId` | *string* | :heavy_check_mark: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `fileId` | *string* | :heavy_check_mark: | N/A | -| `filename` | *string* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.ShellCallOutputItemTypeContainerFileCitation](../models/shellcalloutputitemtypecontainerfilecitation.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `containerId` | *string* | ✅ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `fileId` | *string* | ✅ | N/A | +| `filename` | *string* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `type` | [models.ShellCallOutputItemTypeContainerFileCitation](../models/shellcalloutputitemtypecontainerfilecitation.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/shellservertool.mdx b/docs/models/shellservertool.mdx index e617ecf21..733825216 100644 --- a/docs/models/shellservertool.mdx +++ b/docs/models/shellservertool.mdx @@ -18,4 +18,4 @@ let value: ShellServerTool = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `type` | [models.ShellServerToolType](../models/shellservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.ShellServerToolType](../models/shellservertooltype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/shellservertoolconfig.mdx b/docs/models/shellservertoolconfig.mdx index cd8c49cb7..d4b057f1b 100644 --- a/docs/models/shellservertoolconfig.mdx +++ b/docs/models/shellservertoolconfig.mdx @@ -16,5 +16,5 @@ let value: ShellServerToolConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.ShellServerToolEngine](../models/shellservertoolengine.mdx) | :heavy_minus_sign: | Which shell engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) keeps the provider's native hosted shell when available (OpenAI); on other providers the call is routed to the OpenRouter sandbox. | openrouter | -| `environment` | *models.ShellServerToolEnvironment* | :heavy_minus_sign: | Server-side execution environment for the shell tool. Only container-backed environments are supported; "local" shells are not. | \{
"type": "container_auto"
} | \ No newline at end of file +| `engine` | [models.ShellServerToolEngine](../models/shellservertoolengine.mdx) | ➖ | Which shell engine to use. "openrouter" runs commands server-side in the OpenRouter sandbox. "auto" (default) keeps the provider's native hosted shell when available (OpenAI); on other providers the call is routed to the OpenRouter sandbox. | openrouter | +| `environment` | *models.ShellServerToolEnvironment* | ➖ | Server-side execution environment for the shell tool. Only container-backed environments are supported; "local" shells are not. | \{
"type": "container_auto"
} | \ No newline at end of file diff --git a/docs/models/shellservertoolopenrouter.mdx b/docs/models/shellservertoolopenrouter.mdx index 95e2b08a8..e65a2f781 100644 --- a/docs/models/shellservertoolopenrouter.mdx +++ b/docs/models/shellservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: ShellServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `parameters` | [models.ShellServerToolConfig](../models/shellservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | -| `type` | [models.ShellServerToolOpenRouterType](../models/shellservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.ShellServerToolConfig](../models/shellservertoolconfig.mdx) | ➖ | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | +| `type` | [models.ShellServerToolOpenRouterType](../models/shellservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/sourcecontent.mdx b/docs/models/sourcecontent.mdx index 9f62aabd0..d26ab3be2 100644 --- a/docs/models/sourcecontent.mdx +++ b/docs/models/sourcecontent.mdx @@ -17,5 +17,5 @@ let value: SourceContent = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `content` | *models.AnthropicDocumentBlockParamContent2* | :heavy_check_mark: | N/A | -| `type` | *"content"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *models.AnthropicDocumentBlockParamContent2* | ✅ | N/A | +| `type` | *"content"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/speechinputreferenceaudio.mdx b/docs/models/speechinputreferenceaudio.mdx index 72f677f7b..9b29dd5bd 100644 --- a/docs/models/speechinputreferenceaudio.mdx +++ b/docs/models/speechinputreferenceaudio.mdx @@ -19,5 +19,5 @@ let value: SpeechInputReferenceAudio = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `inputAudio` | [models.SpeechInputReferenceAudioInput](../models/speechinputreferenceaudioinput.mdx) | :heavy_check_mark: | Reference audio input object | -| `type` | *"input_audio"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `inputAudio` | [models.SpeechInputReferenceAudioInput](../models/speechinputreferenceaudioinput.mdx) | ✅ | Reference audio input object | +| `type` | *"input_audio"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/speechinputreferenceaudioinput.mdx b/docs/models/speechinputreferenceaudioinput.mdx index 7dc5c2cc4..779a3094e 100644 --- a/docs/models/speechinputreferenceaudioinput.mdx +++ b/docs/models/speechinputreferenceaudioinput.mdx @@ -16,6 +16,6 @@ let value: SpeechInputReferenceAudioInput = {}; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *string* | :heavy_minus_sign: | Base64-encoded reference audio (optionally a data URI). Supported audio formats are provider-specific. Limited to 20 MiB of base64 (15 MiB of decoded audio). Exactly one of `data` or `url` is required. | data:audio/wav;base64,UklGRuQXDABXQVZF... | -| `format` | *string* | :heavy_minus_sign: | Audio format of the reference audio (e.g., wav, mp3). Optional; most providers detect the format from the audio bytes. | wav | -| `url` | *string* | :heavy_minus_sign: | Public http(s) URL of the reference audio. OpenRouter downloads it (15 MiB max) and forwards the bytes, never the URL. Exactly one of `data` or `url` is required. | https://example.com/reference.wav | \ No newline at end of file +| `data` | *string* | ➖ | Base64-encoded reference audio (optionally a data URI). Supported audio formats are provider-specific. Limited to 20 MiB of base64 (15 MiB of decoded audio). Exactly one of `data` or `url` is required. | data:audio/wav;base64,UklGRuQXDABXQVZF... | +| `format` | *string* | ➖ | Audio format of the reference audio (e.g., wav, mp3). Optional; most providers detect the format from the audio bytes. | wav | +| `url` | *string* | ➖ | Public http(s) URL of the reference audio. OpenRouter downloads it (15 MiB max) and forwards the bytes, never the URL. Exactly one of `data` or `url` is required. | https://example.com/reference.wav | \ No newline at end of file diff --git a/docs/models/speechinputreferenceimage.mdx b/docs/models/speechinputreferenceimage.mdx index 042996bad..f82ab4c58 100644 --- a/docs/models/speechinputreferenceimage.mdx +++ b/docs/models/speechinputreferenceimage.mdx @@ -21,5 +21,5 @@ let value: SpeechInputReferenceImage = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `imageUrl` | [models.SpeechInputReferenceImageInput](../models/speechinputreferenceimageinput.mdx) | :heavy_check_mark: | Reference image input object | -| `type` | *"image_url"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `imageUrl` | [models.SpeechInputReferenceImageInput](../models/speechinputreferenceimageinput.mdx) | ✅ | Reference image input object | +| `type` | *"image_url"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/speechinputreferenceimageinput.mdx b/docs/models/speechinputreferenceimageinput.mdx index 871636012..6dfb7c0f2 100644 --- a/docs/models/speechinputreferenceimageinput.mdx +++ b/docs/models/speechinputreferenceimageinput.mdx @@ -18,4 +18,4 @@ let value: SpeechInputReferenceImageInput = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | *string* | :heavy_check_mark: | JPEG, PNG, or WebP reference image as a base64 data URI or a public http(s) URL. Remote images are downloaded (15 MiB max) and forwarded as bytes, never as the URL. | data:image/png;base64,iVBORw0KGgo... | \ No newline at end of file +| `url` | *string* | ✅ | JPEG, PNG, or WebP reference image as a base64 data URI or a public http(s) URL. Remote images are downloaded (15 MiB max) and forwarded as bytes, never as the URL. | data:image/png;base64,iVBORw0KGgo... | \ No newline at end of file diff --git a/docs/models/speechinputreferencetext.mdx b/docs/models/speechinputreferencetext.mdx index 95f3c95b5..8b16fe3bc 100644 --- a/docs/models/speechinputreferencetext.mdx +++ b/docs/models/speechinputreferencetext.mdx @@ -19,5 +19,5 @@ let value: SpeechInputReferenceText = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `text` | *string* | :heavy_check_mark: | Transcript of an `input_audio` part. With a single clip it may appear before or after the clip; with multiple clips it must immediately follow the clip it transcribes. | I used to rule the world. | -| `type` | *"text"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `text` | *string* | ✅ | Transcript of an `input_audio` part. With a single clip it may appear before or after the clip; with multiple clips it must immediately follow the clip it transcribes. | I used to rule the world. | +| `type` | *"text"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/speechrequest.mdx b/docs/models/speechrequest.mdx index 11b901b21..86b500316 100644 --- a/docs/models/speechrequest.mdx +++ b/docs/models/speechrequest.mdx @@ -19,13 +19,13 @@ let value: SpeechRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `input` | *string* | :heavy_check_mark: | Text to synthesize | Hello world | -| `inputReferences` | *models.SpeechInputReference*[] | :heavy_minus_sign: | Reference content for stateless voice cloning or voice design. Audio mode: one to three `input_audio` parts, each optionally paired with a `text` part carrying its transcript (a single clip accepts its transcript before or after it; with multiple clips each transcript immediately follows its clip); only routed to endpoints that support voice cloning (and multiple references when more than one part is sent). Image mode: exactly one `image_url` part; only routed to endpoints that support image references. The two modes cannot be mixed. An empty array is treated as no reference. | [
\{
"input_audio": \{
"data": "data:audio/wav;base64,UklGRuQXDABXQVZF..."
},
"type": "input_audio"
},
\{
"text": "I used to rule the world.",
"type": "text"
}
] | -| `model` | *string* | :heavy_check_mark: | TTS model identifier | mistralai/voxtral-mini-tts-2603 | -| `provider` | [models.SpeechRequestProvider](../models/speechrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `responseFormat` | [models.SpeechRequestResponseFormat](../models/speechrequestresponseformat.mdx) | :heavy_minus_sign: | Audio output format | pcm | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `speed` | *number* | :heavy_minus_sign: | Playback speed multiplier. Honored by models that support it (e.g. OpenAI TTS). Other providers either ignore it or return a 400 for a non-default value when the model has no speed control. | 1 | -| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `user` | *string* | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | -| `voice` | *string* | :heavy_minus_sign: | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file +| `input` | *string* | ✅ | Text to synthesize | Hello world | +| `inputReferences` | *models.SpeechInputReference*[] | ➖ | Reference content for stateless voice cloning or voice design. Audio mode: one to three `input_audio` parts, each optionally paired with a `text` part carrying its transcript (a single clip accepts its transcript before or after it; with multiple clips each transcript immediately follows its clip); only routed to endpoints that support voice cloning (and multiple references when more than one part is sent). Image mode: exactly one `image_url` part; only routed to endpoints that support image references. The two modes cannot be mixed. An empty array is treated as no reference. | [
\{
"input_audio": \{
"data": "data:audio/wav;base64,UklGRuQXDABXQVZF..."
},
"type": "input_audio"
},
\{
"text": "I used to rule the world.",
"type": "text"
}
] | +| `model` | *string* | ✅ | TTS model identifier | mistralai/voxtral-mini-tts-2603 | +| `provider` | [models.SpeechRequestProvider](../models/speechrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `responseFormat` | [models.SpeechRequestResponseFormat](../models/speechrequestresponseformat.mdx) | ➖ | Audio output format | pcm | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `speed` | *number* | ➖ | Playback speed multiplier. Honored by models that support it (e.g. OpenAI TTS). Other providers either ignore it or return a 400 for a non-default value when the model has no speed control. | 1 | +| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `user` | *string* | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | +| `voice` | *string* | ➖ | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file diff --git a/docs/models/speechrequestprovider.mdx b/docs/models/speechrequestprovider.mdx index 1947c3a54..180f9b14e 100644 --- a/docs/models/speechrequestprovider.mdx +++ b/docs/models/speechrequestprovider.mdx @@ -16,6 +16,6 @@ let value: SpeechRequestProvider = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dataCollection` | [models.SpeechRequestDataCollection](../models/speechrequestdatacollection.mdx) | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | -| `options` | [models.ProviderOptions](../models/provideroptions.mdx) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | -| `zdr` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file +| `dataCollection` | [models.SpeechRequestDataCollection](../models/speechrequestdatacollection.mdx) | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | +| `options` | [models.ProviderOptions](../models/provideroptions.mdx) | ➖ | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | +| `zdr` | *boolean* | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/stance.mdx b/docs/models/stance.mdx index 483e963af..b72fb40c6 100644 --- a/docs/models/stance.mdx +++ b/docs/models/stance.mdx @@ -17,5 +17,5 @@ let value: Stance = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `model` | *string* | :heavy_check_mark: | N/A | -| `stance` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `model` | *string* | ✅ | N/A | +| `stance` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/stopservertoolswhenfinishreasonis.mdx b/docs/models/stopservertoolswhenfinishreasonis.mdx index 1f7e12f9a..1407c9f05 100644 --- a/docs/models/stopservertoolswhenfinishreasonis.mdx +++ b/docs/models/stopservertoolswhenfinishreasonis.mdx @@ -19,5 +19,5 @@ let value: StopServerToolsWhenFinishReasonIs = { | Field | Type | Required | Description | | -------------------- | -------------------- | -------------------- | -------------------- | -| `reason` | *string* | :heavy_check_mark: | N/A | -| `type` | *"finish_reason_is"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `reason` | *string* | ✅ | N/A | +| `type` | *"finish_reason_is"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/stopservertoolswhenhastoolcall.mdx b/docs/models/stopservertoolswhenhastoolcall.mdx index cf9cc36d9..7f688f9d3 100644 --- a/docs/models/stopservertoolswhenhastoolcall.mdx +++ b/docs/models/stopservertoolswhenhastoolcall.mdx @@ -19,5 +19,5 @@ let value: StopServerToolsWhenHasToolCall = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `toolName` | *string* | :heavy_check_mark: | N/A | -| `type` | *"has_tool_call"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `toolName` | *string* | ✅ | N/A | +| `type` | *"has_tool_call"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/stopservertoolswhenmaxcost.mdx b/docs/models/stopservertoolswhenmaxcost.mdx index 8d463b54c..2deb33b3f 100644 --- a/docs/models/stopservertoolswhenmaxcost.mdx +++ b/docs/models/stopservertoolswhenmaxcost.mdx @@ -19,5 +19,5 @@ let value: StopServerToolsWhenMaxCost = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `maxCostInDollars` | *number* | :heavy_check_mark: | N/A | -| `type` | *"max_cost"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `maxCostInDollars` | *number* | ✅ | N/A | +| `type` | *"max_cost"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/stopservertoolswhenmaxtokensused.mdx b/docs/models/stopservertoolswhenmaxtokensused.mdx index c05d50ffb..82e7332c8 100644 --- a/docs/models/stopservertoolswhenmaxtokensused.mdx +++ b/docs/models/stopservertoolswhenmaxtokensused.mdx @@ -19,5 +19,5 @@ let value: StopServerToolsWhenMaxTokensUsed = { | Field | Type | Required | Description | | ------------------- | ------------------- | ------------------- | ------------------- | -| `maxTokens` | *number* | :heavy_check_mark: | N/A | -| `type` | *"max_tokens_used"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `maxTokens` | *number* | ✅ | N/A | +| `type` | *"max_tokens_used"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/stopservertoolswhenstepcountis.mdx b/docs/models/stopservertoolswhenstepcountis.mdx index 7ba0c689e..7105909b6 100644 --- a/docs/models/stopservertoolswhenstepcountis.mdx +++ b/docs/models/stopservertoolswhenstepcountis.mdx @@ -19,5 +19,5 @@ let value: StopServerToolsWhenStepCountIs = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `stepCount` | *number* | :heavy_check_mark: | N/A | -| `type` | *"step_count_is"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `stepCount` | *number* | ✅ | N/A | +| `type` | *"step_count_is"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/storedprompttemplate.mdx b/docs/models/storedprompttemplate.mdx index a82b6f3bc..9d9dd2aa6 100644 --- a/docs/models/storedprompttemplate.mdx +++ b/docs/models/storedprompttemplate.mdx @@ -16,5 +16,5 @@ let value: StoredPromptTemplate = { | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `id` | *string* | :heavy_check_mark: | N/A | -| `variables` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `id` | *string* | ✅ | N/A | +| `variables` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/streameventsresponsecompleted.mdx b/docs/models/streameventsresponsecompleted.mdx index 6591fff0c..79e957ced 100644 --- a/docs/models/streameventsresponsecompleted.mdx +++ b/docs/models/streameventsresponsecompleted.mdx @@ -39,6 +39,6 @@ let value: StreamEventsResponseCompleted = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.completed"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `type` | *"response.completed"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/streameventsresponsefailed.mdx b/docs/models/streameventsresponsefailed.mdx index e5d078e19..6f561f748 100644 --- a/docs/models/streameventsresponsefailed.mdx +++ b/docs/models/streameventsresponsefailed.mdx @@ -39,6 +39,6 @@ let value: StreamEventsResponseFailed = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.failed"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `type` | *"response.failed"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/streameventsresponseincomplete.mdx b/docs/models/streameventsresponseincomplete.mdx index df4f85a38..8b48b96b7 100644 --- a/docs/models/streameventsresponseincomplete.mdx +++ b/docs/models/streameventsresponseincomplete.mdx @@ -39,6 +39,6 @@ let value: StreamEventsResponseIncomplete = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | :heavy_check_mark: | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.incomplete"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `response` | [models.OpenResponsesResult](../models/openresponsesresult.mdx) | ✅ | Complete non-streaming response from the Responses API | \{
"completed_at": 1704067210,
"created_at": 1704067200,
"error": null,
"frequency_penalty": null,
"id": "resp-abc123",
"incomplete_details": null,
"instructions": null,
"max_output_tokens": null,
"metadata": null,
"model": "gpt-4",
"object": "response",
"output": [
\{
"content": [
\{
"annotations": [],
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
}
],
"parallel_tool_calls": true,
"presence_penalty": null,
"status": "completed",
"temperature": null,
"tool_choice": "auto",
"tools": [],
"top_p": null,
"usage": \{
"input_tokens": 10,
"input_tokens_details": \{
"cached_tokens": 0
},
"output_tokens": 25,
"output_tokens_details": \{
"reasoning_tokens": 0
},
"total_tokens": 35
}
} | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `type` | *"response.incomplete"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/streameventsresponseoutputitemadded.mdx b/docs/models/streameventsresponseoutputitemadded.mdx index 0119ae574..c458e7b33 100644 --- a/docs/models/streameventsresponseoutputitemadded.mdx +++ b/docs/models/streameventsresponseoutputitemadded.mdx @@ -31,7 +31,7 @@ let value: StreamEventsResponseOutputItemAdded = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `item` | *models.OutputItems* | :heavy_check_mark: | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.output_item.added"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `item` | *models.OutputItems* | ✅ | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | +| `outputIndex` | *number* | ✅ | N/A | | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `type` | *"response.output_item.added"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/streameventsresponseoutputitemdone.mdx b/docs/models/streameventsresponseoutputitemdone.mdx index 54d0832bc..3305bfb4d 100644 --- a/docs/models/streameventsresponseoutputitemdone.mdx +++ b/docs/models/streameventsresponseoutputitemdone.mdx @@ -31,7 +31,7 @@ let value: StreamEventsResponseOutputItemDone = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `item` | *models.OutputItems* | :heavy_check_mark: | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | | -| `type` | *"response.output_item.done"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `item` | *models.OutputItems* | ✅ | An output item from the response | \{
"content": [
\{
"text": "Hello! How can I help you today?",
"type": "output_text"
}
],
"id": "msg-abc123",
"role": "assistant",
"status": "completed",
"type": "message"
} | +| `outputIndex` | *number* | ✅ | N/A | | +| `sequenceNumber` | *number* | ✅ | N/A | | +| `type` | *"response.output_item.done"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/streamlogprob.mdx b/docs/models/streamlogprob.mdx index eb20d99cb..8d0b3f71b 100644 --- a/docs/models/streamlogprob.mdx +++ b/docs/models/streamlogprob.mdx @@ -19,7 +19,7 @@ let value: StreamLogprob = { | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `bytes` | *number*[] | :heavy_minus_sign: | N/A | -| `logprob` | *number* | :heavy_check_mark: | N/A | -| `token` | *string* | :heavy_check_mark: | N/A | -| `topLogprobs` | [models.StreamLogprobTopLogprob](../models/streamlogprobtoplogprob.mdx)[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `bytes` | *number*[] | ➖ | N/A | +| `logprob` | *number* | ✅ | N/A | +| `token` | *string* | ✅ | N/A | +| `topLogprobs` | [models.StreamLogprobTopLogprob](../models/streamlogprobtoplogprob.mdx)[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/streamlogprobtoplogprob.mdx b/docs/models/streamlogprobtoplogprob.mdx index b11ce7bcb..ee4778471 100644 --- a/docs/models/streamlogprobtoplogprob.mdx +++ b/docs/models/streamlogprobtoplogprob.mdx @@ -16,6 +16,6 @@ let value: StreamLogprobTopLogprob = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `bytes` | *number*[] | :heavy_minus_sign: | N/A | -| `logprob` | *number* | :heavy_minus_sign: | N/A | -| `token` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `bytes` | *number*[] | ➖ | N/A | +| `logprob` | *number* | ➖ | N/A | +| `token` | *string* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/stt.mdx b/docs/models/stt.mdx index 4ae186002..7c0bb8cad 100644 --- a/docs/models/stt.mdx +++ b/docs/models/stt.mdx @@ -28,6 +28,6 @@ let value: STT = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `requestCount` | *number* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `requestCount` | *number* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/sttentity.mdx b/docs/models/sttentity.mdx index d29143f34..7eb9eaf38 100644 --- a/docs/models/sttentity.mdx +++ b/docs/models/sttentity.mdx @@ -21,7 +21,7 @@ let value: STTEntity = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `endChar` | *number* | :heavy_check_mark: | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | -| `startChar` | *number* | :heavy_check_mark: | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | -| `text` | *string* | :heavy_check_mark: | Entity text as it appears in the transcript | | -| `type` | *string* | :heavy_check_mark: | Provider entity type label | name | \ No newline at end of file +| `endChar` | *number* | ✅ | Zero-based exclusive character offset of the entity end within the response-level text (not seconds) | 25 | +| `startChar` | *number* | ✅ | Zero-based character offset of the entity start within the response-level text (not seconds) | 15 | +| `text` | *string* | ✅ | Entity text as it appears in the transcript | | +| `type` | *string* | ✅ | Provider entity type label | name | \ No newline at end of file diff --git a/docs/models/sttinlineinputaudio.mdx b/docs/models/sttinlineinputaudio.mdx index 0071dd119..914cc7018 100644 --- a/docs/models/sttinlineinputaudio.mdx +++ b/docs/models/sttinlineinputaudio.mdx @@ -19,5 +19,5 @@ let value: STTInlineInputAudio = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *string* | :heavy_check_mark: | Base64-encoded audio data (raw bytes, not a data URI) | -| `format` | *string* | :heavy_check_mark: | Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported formats vary by provider. "pcm" means headerless signed 16-bit little-endian mono audio at 16 kHz. | \ No newline at end of file +| `data` | *string* | ✅ | Base64-encoded audio data (raw bytes, not a data URI) | +| `format` | *string* | ✅ | Audio format (e.g., wav, mp3, flac, m4a, ogg, webm, aac). Supported formats vary by provider. "pcm" means headerless signed 16-bit little-endian mono audio at 16 kHz. | \ No newline at end of file diff --git a/docs/models/sttrequest.mdx b/docs/models/sttrequest.mdx index d385cc14c..f9125a1c9 100644 --- a/docs/models/sttrequest.mdx +++ b/docs/models/sttrequest.mdx @@ -22,15 +22,15 @@ let value: STTRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `diarize` | *boolean* | :heavy_minus_sign: | Label each word with the speaker who said it. Speaker labels are returned on the words array (speaker, speaker_label), so response_format must be "verbose_json" (a "json" request is rejected with a 400) and word timestamps are included even when timestamp_granularities omits "word". Only supported by some providers; the request is rejected with a 400 when the selected model cannot diarize. Providers may charge extra. | true | -| `inputAudio` | *models.STTInputAudio* | :heavy_check_mark: | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | -| `keyterms` | *string*[] | :heavy_minus_sign: | Domain terms, names, or phrases to bias recognition toward. Only supported by some providers; the request is rejected with a 400 when the selected model cannot use keyterms. Providers may cap the number of terms or characters per term and may charge extra. | [
"OpenRouter",
"Scribe"
] | -| `language` | *string* | :heavy_minus_sign: | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | -| `model` | *string* | :heavy_check_mark: | STT model identifier | openai/whisper-large-v3 | -| `provider` | [models.STTRequestProvider](../models/sttrequestprovider.mdx) | :heavy_minus_sign: | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | -| `responseFormat` | [models.STTRequestResponseFormat](../models/sttrequestresponseformat.mdx) | :heavy_minus_sign: | Output format. "json" (default) returns \{ text, usage }. "verbose_json" additionally returns task, language, duration, and segment-level timestamps; only supported by OpenAI-compatible providers. | json | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `temperature` | *number* | :heavy_minus_sign: | Sampling temperature for transcription | 0 | -| `timestampGranularities` | [models.STTTimestampGranularity](../models/stttimestampgranularity.mdx)[] | :heavy_minus_sign: | Timestamp detail levels to include when response_format is "verbose_json". "segment" returns segment-level timestamps; "word" additionally returns word-level timestamps in the words array. Ignored unless response_format is "verbose_json". | [
"segment"
] | -| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `user` | *string* | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file +| `diarize` | *boolean* | ➖ | Label each word with the speaker who said it. Speaker labels are returned on the words array (speaker, speaker_label), so response_format must be "verbose_json" (a "json" request is rejected with a 400) and word timestamps are included even when timestamp_granularities omits "word". Only supported by some providers; the request is rejected with a 400 when the selected model cannot diarize. Providers may charge extra. | true | +| `inputAudio` | *models.STTInputAudio* | ✅ | Audio to transcribe: inline base64 bytes, or a URL the provider downloads directly. | | +| `keyterms` | *string*[] | ➖ | Domain terms, names, or phrases to bias recognition toward. Only supported by some providers; the request is rejected with a 400 when the selected model cannot use keyterms. Providers may cap the number of terms or characters per term and may charge extra. | [
"OpenRouter",
"Scribe"
] | +| `language` | *string* | ➖ | ISO-639-1 language code (e.g., "en", "ja"). Auto-detected if omitted. | en | +| `model` | *string* | ✅ | STT model identifier | openai/whisper-large-v3 | +| `provider` | [models.STTRequestProvider](../models/sttrequestprovider.mdx) | ➖ | Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options | | +| `responseFormat` | [models.STTRequestResponseFormat](../models/sttrequestresponseformat.mdx) | ➖ | Output format. "json" (default) returns \{ text, usage }. "verbose_json" additionally returns task, language, duration, and segment-level timestamps; only supported by OpenAI-compatible providers. | json | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `temperature` | *number* | ➖ | Sampling temperature for transcription | 0 | +| `timestampGranularities` | [models.STTTimestampGranularity](../models/stttimestampgranularity.mdx)[] | ➖ | Timestamp detail levels to include when response_format is "verbose_json". "segment" returns segment-level timestamps; "word" additionally returns word-level timestamps in the words array. Ignored unless response_format is "verbose_json". | [
"segment"
] | +| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `user` | *string* | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file diff --git a/docs/models/sttrequestprovider.mdx b/docs/models/sttrequestprovider.mdx index 42b027540..d93017035 100644 --- a/docs/models/sttrequestprovider.mdx +++ b/docs/models/sttrequestprovider.mdx @@ -16,6 +16,6 @@ let value: STTRequestProvider = {}; | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dataCollection` | [models.STTRequestDataCollection](../models/sttrequestdatacollection.mdx) | :heavy_minus_sign: | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | -| `options` | [models.ProviderOptions](../models/provideroptions.mdx) | :heavy_minus_sign: | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | -| `zdr` | *boolean* | :heavy_minus_sign: | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file +| `dataCollection` | [models.STTRequestDataCollection](../models/sttrequestdatacollection.mdx) | ➖ | Data collection setting. If no available model provider meets the requirement, your request will return an error.
- allow: (default) allow providers which store user data non-transiently and may train on it

- deny: use only providers which do not collect user data. | allow | +| `options` | [models.ProviderOptions](../models/provideroptions.mdx) | ➖ | Provider-specific options keyed by provider slug. Only options for the matched provider are forwarded; the rest are ignored. Unrecognized keys are silently dropped. | \{
"openai": \{
"max_tokens": 1000
}
} | +| `zdr` | *boolean* | ➖ | Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used. | true | \ No newline at end of file diff --git a/docs/models/sttresponse.mdx b/docs/models/sttresponse.mdx index 2d839a42e..207e36534 100644 --- a/docs/models/sttresponse.mdx +++ b/docs/models/sttresponse.mdx @@ -18,13 +18,13 @@ let value: STTResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `confidence` | *number* | :heavy_minus_sign: | Provider confidence for the whole transcript from 0 to 1, present when response_format is verbose_json and the provider scores the full transcript | 0.94 | -| `duration` | *number* | :heavy_minus_sign: | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | -| `entities` | [models.STTEntity](../models/sttentity.mdx)[] | :heavy_minus_sign: | Detected entities with character offsets into text, present when the provider runs entity detection | | -| `language` | *string* | :heavy_minus_sign: | Detected or forced language, present when response_format is verbose_json | english | -| `languageConfidence` | *number* | :heavy_minus_sign: | Provider confidence in the detected language from 0 to 1, present when response_format is verbose_json and the provider scores language detection | 0.98 | -| `segments` | [models.STTSegment](../models/sttsegment.mdx)[] | :heavy_minus_sign: | Timestamped transcript segments, present when response_format is verbose_json | | -| `task` | *string* | :heavy_minus_sign: | The task performed, present when response_format is verbose_json | transcribe | -| `text` | *string* | :heavy_check_mark: | The transcribed text | Hello, this is a test of OpenAI speech-to-text transcription. The weather is sunny today and the temperature is around 72 degrees. | -| `usage` | [models.STTUsage](../models/sttusage.mdx) | :heavy_minus_sign: | Aggregated usage statistics for the request | \{
"cost": 0.000508,
"input_tokens": 83,
"output_tokens": 30,
"seconds": 9.2,
"total_tokens": 113
} | -| `words` | [models.STTWord](../models/sttword.mdx)[] | :heavy_minus_sign: | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file +| `confidence` | *number* | ➖ | Provider confidence for the whole transcript from 0 to 1, present when response_format is verbose_json and the provider scores the full transcript | 0.94 | +| `duration` | *number* | ➖ | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | +| `entities` | [models.STTEntity](../models/sttentity.mdx)[] | ➖ | Detected entities with character offsets into text, present when the provider runs entity detection | | +| `language` | *string* | ➖ | Detected or forced language, present when response_format is verbose_json | english | +| `languageConfidence` | *number* | ➖ | Provider confidence in the detected language from 0 to 1, present when response_format is verbose_json and the provider scores language detection | 0.98 | +| `segments` | [models.STTSegment](../models/sttsegment.mdx)[] | ➖ | Timestamped transcript segments, present when response_format is verbose_json | | +| `task` | *string* | ➖ | The task performed, present when response_format is verbose_json | transcribe | +| `text` | *string* | ✅ | The transcribed text | Hello, this is a test of OpenAI speech-to-text transcription. The weather is sunny today and the temperature is around 72 degrees. | +| `usage` | [models.STTUsage](../models/sttusage.mdx) | ➖ | Aggregated usage statistics for the request | \{
"cost": 0.000508,
"input_tokens": 83,
"output_tokens": 30,
"seconds": 9.2,
"total_tokens": 113
} | +| `words` | [models.STTWord](../models/sttword.mdx)[] | ➖ | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file diff --git a/docs/models/sttsegment.mdx b/docs/models/sttsegment.mdx index a921841bd..decc77f3c 100644 --- a/docs/models/sttsegment.mdx +++ b/docs/models/sttsegment.mdx @@ -21,16 +21,16 @@ let value: STTSegment = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `avgLogprob` | *number* | :heavy_minus_sign: | Average log probability of the segment | | -| `channel` | *number* | :heavy_minus_sign: | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | -| `compressionRatio` | *number* | :heavy_minus_sign: | Compression ratio of the segment | | -| `end` | *number* | :heavy_check_mark: | Segment end time in seconds | 3.2 | -| `id` | *number* | :heavy_check_mark: | Segment index within the transcript | 0 | -| `noSpeechProb` | *number* | :heavy_minus_sign: | Probability the segment contains no speech | | -| `seek` | *number* | :heavy_minus_sign: | Seek offset of the segment | 0 | -| `speaker` | *number* | :heavy_minus_sign: | Speaker index for the segment, present when the provider returns diarization data | 0 | -| `speakerLabel` | *string* | :heavy_minus_sign: | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | -| `start` | *number* | :heavy_check_mark: | Segment start time in seconds | 0 | -| `temperature` | *number* | :heavy_minus_sign: | Temperature used for the segment | | -| `text` | *string* | :heavy_check_mark: | Transcribed text of the segment | Hello there. | -| `tokens` | *number*[] | :heavy_minus_sign: | Token IDs of the segment | | \ No newline at end of file +| `avgLogprob` | *number* | ➖ | Average log probability of the segment | | +| `channel` | *number* | ➖ | Zero-based audio channel index for the segment, present when the provider transcribes channels separately | 0 | +| `compressionRatio` | *number* | ➖ | Compression ratio of the segment | | +| `end` | *number* | ✅ | Segment end time in seconds | 3.2 | +| `id` | *number* | ✅ | Segment index within the transcript | 0 | +| `noSpeechProb` | *number* | ➖ | Probability the segment contains no speech | | +| `seek` | *number* | ➖ | Seek offset of the segment | 0 | +| `speaker` | *number* | ➖ | Speaker index for the segment, present when the provider returns diarization data | 0 | +| `speakerLabel` | *string* | ➖ | Provider speaker label for the segment, present when the provider labels speakers with a string | speaker_0 | +| `start` | *number* | ✅ | Segment start time in seconds | 0 | +| `temperature` | *number* | ➖ | Temperature used for the segment | | +| `text` | *string* | ✅ | Transcribed text of the segment | Hello there. | +| `tokens` | *number*[] | ➖ | Token IDs of the segment | | \ No newline at end of file diff --git a/docs/models/stturlinputaudio.mdx b/docs/models/stturlinputaudio.mdx index 19572f868..672282208 100644 --- a/docs/models/stturlinputaudio.mdx +++ b/docs/models/stturlinputaudio.mdx @@ -18,5 +18,5 @@ let value: STTUrlInputAudio = { | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | *string* | :heavy_minus_sign: | Audio format of the file at the URL. Defaults to the extension of the URL path; required when the path has no extension. | -| `url` | *string* | :heavy_check_mark: | Publicly reachable http(s) URL of the audio file. The provider downloads it directly, so the inline upload size limit does not apply. Only supported by some providers. | \ No newline at end of file +| `format` | *string* | ➖ | Audio format of the file at the URL. Defaults to the extension of the URL path; required when the path has no extension. | +| `url` | *string* | ✅ | Publicly reachable http(s) URL of the audio file. The provider downloads it directly, so the inline upload size limit does not apply. Only supported by some providers. | \ No newline at end of file diff --git a/docs/models/sttusage.mdx b/docs/models/sttusage.mdx index 99ed839ab..0e45ea7c4 100644 --- a/docs/models/sttusage.mdx +++ b/docs/models/sttusage.mdx @@ -16,8 +16,8 @@ let value: STTUsage = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `cost` | *number* | :heavy_minus_sign: | Total cost of the request in USD | 0.000508 | -| `inputTokens` | *number* | :heavy_minus_sign: | Number of input tokens billed for this request | 83 | -| `outputTokens` | *number* | :heavy_minus_sign: | Number of output tokens generated | 30 | -| `seconds` | *number* | :heavy_minus_sign: | Duration of the input audio in seconds | 9.2 | -| `totalTokens` | *number* | :heavy_minus_sign: | Total number of tokens used (input + output) | 113 | \ No newline at end of file +| `cost` | *number* | ➖ | Total cost of the request in USD | 0.000508 | +| `inputTokens` | *number* | ➖ | Number of input tokens billed for this request | 83 | +| `outputTokens` | *number* | ➖ | Number of output tokens generated | 30 | +| `seconds` | *number* | ➖ | Duration of the input audio in seconds | 9.2 | +| `totalTokens` | *number* | ➖ | Total number of tokens used (input + output) | 113 | \ No newline at end of file diff --git a/docs/models/sttword.mdx b/docs/models/sttword.mdx index b257d9890..d2a9906ea 100644 --- a/docs/models/sttword.mdx +++ b/docs/models/sttword.mdx @@ -20,11 +20,11 @@ let value: STTWord = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `channel` | *number* | :heavy_minus_sign: | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | -| `confidence` | *number* | :heavy_minus_sign: | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | -| `end` | *number* | :heavy_check_mark: | Word end time in seconds | 0.4 | -| `speaker` | *number* | :heavy_minus_sign: | Speaker index for the word, present when the provider returns diarization data | 0 | -| `speakerLabel` | *string* | :heavy_minus_sign: | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | -| `start` | *number* | :heavy_check_mark: | Word start time in seconds | 0 | -| `type` | [models.STTWordType](../models/sttwordtype.mdx) | :heavy_minus_sign: | Kind of entry; omitted or "word" for spoken words, "audio_event" for non-speech sounds the provider tags with timestamps | word | -| `word` | *string* | :heavy_check_mark: | The transcribed word, or the event tag such as "(laughter)" when type is audio_event | Hello | \ No newline at end of file +| `channel` | *number* | ➖ | Zero-based audio channel index for the word, present when the provider transcribes channels separately | 0 | +| `confidence` | *number* | ➖ | Provider confidence for the word from 0 to 1, present when the provider returns per-word confidence | 0.98 | +| `end` | *number* | ✅ | Word end time in seconds | 0.4 | +| `speaker` | *number* | ➖ | Speaker index for the word, present when the provider returns diarization data | 0 | +| `speakerLabel` | *string* | ➖ | Provider speaker label for the word, present when the provider labels speakers with a string | speaker_0 | +| `start` | *number* | ✅ | Word start time in seconds | 0 | +| `type` | [models.STTWordType](../models/sttwordtype.mdx) | ➖ | Kind of entry; omitted or "word" for spoken words, "audio_event" for non-speech sounds the provider tags with timestamps | word | +| `word` | *string* | ✅ | The transcribed word, or the event tag such as "(laughter)" when type is audio_event | Hello | \ No newline at end of file diff --git a/docs/models/subagentnestedtool.mdx b/docs/models/subagentnestedtool.mdx index b3e7f0a5f..5134b3b1f 100644 --- a/docs/models/subagentnestedtool.mdx +++ b/docs/models/subagentnestedtool.mdx @@ -18,6 +18,6 @@ let value: SubagentNestedTool = { | Field | Type | Required | Description | Example | | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | -| `parameters` | Record\ | :heavy_minus_sign: | N/A | | -| `type` | *string* | :heavy_check_mark: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file +| `parameters` | Record\ | ➖ | N/A | | +| `type` | *string* | ✅ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"type": "openrouter:web_search"
} | \ No newline at end of file diff --git a/docs/models/subagentreasoning.mdx b/docs/models/subagentreasoning.mdx index bf7dae1c7..eed602016 100644 --- a/docs/models/subagentreasoning.mdx +++ b/docs/models/subagentreasoning.mdx @@ -16,5 +16,5 @@ let value: SubagentReasoning = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `effort` | [models.SubagentReasoningEffort](../models/subagentreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the subagent call. | -| `maxTokens` | *number* | :heavy_minus_sign: | Maximum number of reasoning tokens the subagent may use. Forwarded to the subagent call as `reasoning.max_tokens`. | \ No newline at end of file +| `effort` | [models.SubagentReasoningEffort](../models/subagentreasoningeffort.mdx) | ➖ | Reasoning effort level for the subagent call. | +| `maxTokens` | *number* | ➖ | Maximum number of reasoning tokens the subagent may use. Forwarded to the subagent call as `reasoning.max_tokens`. | \ No newline at end of file diff --git a/docs/models/subagentservertoolconfig.mdx b/docs/models/subagentservertoolconfig.mdx index 2aad8f8d2..302c17ec6 100644 --- a/docs/models/subagentservertoolconfig.mdx +++ b/docs/models/subagentservertoolconfig.mdx @@ -16,13 +16,13 @@ let value: SubagentServerToolConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `inheritFunctions` | *boolean* | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. When true, the subagent inherits every client function defined in the request's top-level `tools` list. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | true | -| `inheritedFunctionNames` | *string*[] | :heavy_minus_sign: | EXPERIMENTAL — subject to change without notice. Names of the top-level function tools that the subagent will inherit. Any tool that matches by name will be copied fully into the tools array of the subagent. When `inherit_functions` is `true`, this list does nothing, because every client function will be inherited by default. Names are trimmed before validation, so a whitespace-only name is rejected with a `400`. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | [
"lookup_order"
] | -| `instructions` | *string* | :heavy_minus_sign: | System instructions for the subagent. When omitted, the subagent responds with no system prompt of its own. | You are a fast, focused worker. Complete the task exactly as described. | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | -| `maxToolCalls` | *number* | :heavy_minus_sign: | Maximum number of tool-calling steps the subagent may take during its agentic loop. Capped at 25. Only relevant when the subagent is given tools. Forwarded to the subagent call as `max_tool_calls`. | 5 | -| `model` | *string* | :heavy_minus_sign: | Slug of the model that executes delegated tasks (any OpenRouter model). Typically a smaller, cheaper, faster model than the one delegating. When omitted, the model from the outer API request is used. The subagent tool itself cannot be the subagent model. | ~anthropic/claude-haiku-latest | -| `name` | *string* | :heavy_minus_sign: | Optional name for this subagent. The model sees one tool per named subagent (and one default for an unnamed entry). Names must be unique across subagent entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | summarizer | -| `reasoning` | [models.SubagentReasoning](../models/subagentreasoning.mdx) | :heavy_minus_sign: | Reasoning configuration forwarded to the subagent call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "low"
} | -| `temperature` | *number* | :heavy_minus_sign: | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | -| `tools` | [models.SubagentNestedTool](../models/subagentnestedtool.mdx)[] | :heavy_minus_sign: | Tools the subagent may use while executing a delegated task. The subagent runs as an agentic sub-agent over these tools, then returns its outcome. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the subagent tool itself. | | \ No newline at end of file +| `inheritFunctions` | *boolean* | ➖ | EXPERIMENTAL — subject to change without notice. When true, the subagent inherits every client function defined in the request's top-level `tools` list. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | true | +| `inheritedFunctionNames` | *string*[] | ➖ | EXPERIMENTAL — subject to change without notice. Names of the top-level function tools that the subagent will inherit. Any tool that matches by name will be copied fully into the tools array of the subagent. When `inherit_functions` is `true`, this list does nothing, because every client function will be inherited by default. Names are trimmed before validation, so a whitespace-only name is rejected with a `400`. Supported on the Responses API (`/api/v1/responses`) only; other APIs reject it with a `400`. | [
"lookup_order"
] | +| `instructions` | *string* | ➖ | System instructions for the subagent. When omitted, the subagent responds with no system prompt of its own. | You are a fast, focused worker. Complete the task exactly as described. | +| `maxCompletionTokens` | *number* | ➖ | Maximum number of output tokens (including reasoning) the subagent may produce. When omitted, the provider's default applies. | 2048 | +| `maxToolCalls` | *number* | ➖ | Maximum number of tool-calling steps the subagent may take during its agentic loop. Capped at 25. Only relevant when the subagent is given tools. Forwarded to the subagent call as `max_tool_calls`. | 5 | +| `model` | *string* | ➖ | Slug of the model that executes delegated tasks (any OpenRouter model). Typically a smaller, cheaper, faster model than the one delegating. When omitted, the model from the outer API request is used. The subagent tool itself cannot be the subagent model. | ~anthropic/claude-haiku-latest | +| `name` | *string* | ➖ | Optional name for this subagent. The model sees one tool per named subagent (and one default for an unnamed entry). Names must be unique across subagent entries. Letters, digits, spaces, underscores, and dashes; trimmed; 1–64 chars. | summarizer | +| `reasoning` | [models.SubagentReasoning](../models/subagentreasoning.mdx) | ➖ | Reasoning configuration forwarded to the subagent call. Use this to control reasoning effort and token budget for models that support extended thinking. | \{
"effort": "low"
} | +| `temperature` | *number* | ➖ | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | +| `tools` | [models.SubagentNestedTool](../models/subagentnestedtool.mdx)[] | ➖ | Tools the subagent may use while executing a delegated task. The subagent runs as an agentic sub-agent over these tools, then returns its outcome. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the subagent tool itself. | | \ No newline at end of file diff --git a/docs/models/subagentservertoolopenrouter.mdx b/docs/models/subagentservertoolopenrouter.mdx index 3d1923156..76db5373e 100644 --- a/docs/models/subagentservertoolopenrouter.mdx +++ b/docs/models/subagentservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: SubagentServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `parameters` | [models.SubagentServerToolConfig](../models/subagentservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | -| `type` | [models.SubagentServerToolOpenRouterType](../models/subagentservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.SubagentServerToolConfig](../models/subagentservertoolconfig.mdx) | ➖ | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | +| `type` | [models.SubagentServerToolOpenRouterType](../models/subagentservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/submitgenerationfeedbackrequest.mdx b/docs/models/submitgenerationfeedbackrequest.mdx index 92aa35e53..c9e040ca7 100644 --- a/docs/models/submitgenerationfeedbackrequest.mdx +++ b/docs/models/submitgenerationfeedbackrequest.mdx @@ -19,6 +19,6 @@ let value: SubmitGenerationFeedbackRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `category` | [models.SubmitGenerationFeedbackRequestCategory](../models/submitgenerationfeedbackrequestcategory.mdx) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | -| `comment` | *string* | :heavy_minus_sign: | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | -| `generationId` | *string* | :heavy_check_mark: | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file +| `category` | [models.SubmitGenerationFeedbackRequestCategory](../models/submitgenerationfeedbackrequestcategory.mdx) | ✅ | The category of feedback being reported | incorrect_response | +| `comment` | *string* | ➖ | An optional free-text comment describing the feedback | The model repeated the same paragraph three times. | +| `generationId` | *string* | ✅ | The generation to submit feedback on | gen-3bhGkxlo4XFrqiabUM7NDtwDzWwG | \ No newline at end of file diff --git a/docs/models/submitgenerationfeedbackresponse.mdx b/docs/models/submitgenerationfeedbackresponse.mdx index 5c73a0966..f6e44f5e2 100644 --- a/docs/models/submitgenerationfeedbackresponse.mdx +++ b/docs/models/submitgenerationfeedbackresponse.mdx @@ -20,4 +20,4 @@ let value: SubmitGenerationFeedbackResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `data` | [models.SubmitGenerationFeedbackResponseData](../models/submitgenerationfeedbackresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.SubmitGenerationFeedbackResponseData](../models/submitgenerationfeedbackresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/submitgenerationfeedbackresponsedata.mdx b/docs/models/submitgenerationfeedbackresponsedata.mdx index 49323cbf6..007186548 100644 --- a/docs/models/submitgenerationfeedbackresponsedata.mdx +++ b/docs/models/submitgenerationfeedbackresponsedata.mdx @@ -16,4 +16,4 @@ let value: SubmitGenerationFeedbackResponseData = { | Field | Type | Required | Description | Example | | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `success` | *true* | :heavy_check_mark: | Whether the feedback was recorded | true | \ No newline at end of file +| `success` | *true* | ✅ | Whether the feedback was recorded | true | \ No newline at end of file diff --git a/docs/models/suspendinternresponse.mdx b/docs/models/suspendinternresponse.mdx index 28c6767d5..9debe6b4d 100644 --- a/docs/models/suspendinternresponse.mdx +++ b/docs/models/suspendinternresponse.mdx @@ -16,4 +16,4 @@ let value: SuspendInternResponse = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `suspended` | *true* | :heavy_check_mark: | N/A | \ No newline at end of file +| `suspended` | *true* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/switchyardrouterplugin.mdx b/docs/models/switchyardrouterplugin.mdx index 436a80f1d..951415155 100644 --- a/docs/models/switchyardrouterplugin.mdx +++ b/docs/models/switchyardrouterplugin.mdx @@ -16,6 +16,6 @@ let value: SwitchyardRouterPlugin = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `algorithm` | [models.Algorithm](../models/algorithm.mdx) | :heavy_minus_sign: | Routing algorithm for this request. "capability" calls a small judge model to rate how demanding the task is, then picks the efficient or capable candidate. "stage" reads the tool-result history (errors, repeated failures, edits landing) and calls the judge only when those signals are undecided. "auto" is "stage" without the judge call. "random" picks one candidate at random. "composite" keeps the tier chosen on the last human turn and re-evaluates tool turns with the stage signals. "passthrough" serves the eligible candidates in the order OpenRouter already ranked them, with no routing decision and no judge call. Omit this field to use the platform default, stage. | | -| `id` | *"switchyard-router"* | :heavy_check_mark: | N/A | | -| `judgeModel` | *string* | :heavy_minus_sign: | The model that runs the judge call for the judge-backed algorithms ("capability", "stage", and "composite"). The model must support structured outputs and have a provider that your account and request settings allow. Otherwise, the request uses the platform default judge, google/gemini-2.5-flash-lite, and reports the reason in the routing metadata. The judge call is billed to you like any other request. | openai/gpt-5.4-nano | \ No newline at end of file +| `algorithm` | [models.Algorithm](../models/algorithm.mdx) | ➖ | Routing algorithm for this request. "capability" calls a small judge model to rate how demanding the task is, then picks the efficient or capable candidate. "stage" reads the tool-result history (errors, repeated failures, edits landing) and calls the judge only when those signals are undecided. "auto" is "stage" without the judge call. "random" picks one candidate at random. "composite" keeps the tier chosen on the last human turn and re-evaluates tool turns with the stage signals. "passthrough" serves the eligible candidates in the order OpenRouter already ranked them, with no routing decision and no judge call. Omit this field to use the platform default, stage. | | +| `id` | *"switchyard-router"* | ✅ | N/A | | +| `judgeModel` | *string* | ➖ | The model that runs the judge call for the judge-backed algorithms ("capability", "stage", and "composite"). The model must support structured outputs and have a provider that your account and request settings allow. Otherwise, the request uses the platform default judge, google/gemini-2.5-flash-lite, and reports the reason in the routing metadata. The judge call is billed to you like any other request. | openai/gpt-5.4-nano | \ No newline at end of file diff --git a/docs/models/taskbudget.mdx b/docs/models/taskbudget.mdx index bfcc958be..ec91975e5 100644 --- a/docs/models/taskbudget.mdx +++ b/docs/models/taskbudget.mdx @@ -19,6 +19,6 @@ let value: TaskBudget = { | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `remaining` | *number* | :heavy_minus_sign: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.TypeTokens](../models/typetokens.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `remaining` | *number* | ➖ | N/A | +| `total` | *number* | ✅ | N/A | +| `type` | [models.TypeTokens](../models/typetokens.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/taskclassificationitem.mdx b/docs/models/taskclassificationitem.mdx index e5b5195c3..d56735470 100644 --- a/docs/models/taskclassificationitem.mdx +++ b/docs/models/taskclassificationitem.mdx @@ -34,11 +34,11 @@ let value: TaskClassificationItem = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `categoryTokenShare` | *number* | :heavy_check_mark: | Fraction of this classification's token volume within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.48 | -| `categoryUsageShare` | *number* | :heavy_check_mark: | Fraction of this classification's usage within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.51 | -| `displayName` | *string* | :heavy_check_mark: | Human-readable label for the classification. | Code Generation | -| `macroCategory` | *string* | :heavy_check_mark: | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | -| `models` | [models.TaskClassificationModel](../models/taskclassificationmodel.mdx)[] | :heavy_check_mark: | Top models for this classification by request volume, sorted descending. Each entry reports the model's share of this classification's requests and tokens. | | -| `tag` | *string* | :heavy_check_mark: | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | -| `tokenShare` | *number* | :heavy_check_mark: | Fraction of classified sampled token volume (prompt + completion) attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.31 | -| `usageShare` | *number* | :heavy_check_mark: | Fraction of classified sampled requests attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.23 | \ No newline at end of file +| `categoryTokenShare` | *number* | ✅ | Fraction of this classification's token volume within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.48 | +| `categoryUsageShare` | *number* | ✅ | Fraction of this classification's usage within its macro-category (0–1). Sums to 1 across all classifications sharing the same `macro_category`. | 0.51 | +| `displayName` | *string* | ✅ | Human-readable label for the classification. | Code Generation | +| `macroCategory` | *string* | ✅ | Coarse grouping derived from the tag prefix: `code`, `data`, `agent`, or `general`. | code | +| `models` | [models.TaskClassificationModel](../models/taskclassificationmodel.mdx)[] | ✅ | Top models for this classification by request volume, sorted descending. Each entry reports the model's share of this classification's requests and tokens. | | +| `tag` | *string* | ✅ | Classification tag identifier (e.g. `code:general_impl`, `agent:web_search`). | code:general_impl | +| `tokenShare` | *number* | ✅ | Fraction of classified sampled token volume (prompt + completion) attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.31 | +| `usageShare` | *number* | ✅ | Fraction of classified sampled requests attributed to this classification (0–1). The unclassified `other` bucket is excluded from the denominator. | 0.23 | \ No newline at end of file diff --git a/docs/models/taskclassificationmacrocategory.mdx b/docs/models/taskclassificationmacrocategory.mdx index c7e9b7b51..9a9980bb4 100644 --- a/docs/models/taskclassificationmacrocategory.mdx +++ b/docs/models/taskclassificationmacrocategory.mdx @@ -19,7 +19,7 @@ let value: TaskClassificationMacroCategory = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `key` | *string* | :heavy_check_mark: | Macro-category identifier. | code | -| `label` | *string* | :heavy_check_mark: | Human-readable label for the macro-category. | Code | -| `tokenShare` | *number* | :heavy_check_mark: | Combined token share of all classifications in this macro-category (0–1). | 0.52 | -| `usageShare` | *number* | :heavy_check_mark: | Combined usage share of all classifications in this macro-category (0–1). | 0.45 | \ No newline at end of file +| `key` | *string* | ✅ | Macro-category identifier. | code | +| `label` | *string* | ✅ | Human-readable label for the macro-category. | Code | +| `tokenShare` | *number* | ✅ | Combined token share of all classifications in this macro-category (0–1). | 0.52 | +| `usageShare` | *number* | ✅ | Combined usage share of all classifications in this macro-category (0–1). | 0.45 | \ No newline at end of file diff --git a/docs/models/taskclassificationmodel.mdx b/docs/models/taskclassificationmodel.mdx index 984e1d865..3c93eb8cc 100644 --- a/docs/models/taskclassificationmodel.mdx +++ b/docs/models/taskclassificationmodel.mdx @@ -18,6 +18,6 @@ let value: TaskClassificationModel = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *string* | :heavy_check_mark: | Model identifier (permaslug). | openai/gpt-4.1-mini | -| `tagTokenShare` | *number* | :heavy_check_mark: | Fraction of this classification's sampled token volume attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.75 | -| `tagUsageShare` | *number* | :heavy_check_mark: | Fraction of this classification's sampled requests attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.55 | \ No newline at end of file +| `id` | *string* | ✅ | Model identifier (permaslug). | openai/gpt-4.1-mini | +| `tagTokenShare` | *number* | ✅ | Fraction of this classification's sampled token volume attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.75 | +| `tagUsageShare` | *number* | ✅ | Fraction of this classification's sampled requests attributed to this model (0–1). Sums to ≤1 across the returned models (only top-N are included and unattributed requests are excluded). | 0.55 | \ No newline at end of file diff --git a/docs/models/taskclassificationresponse.mdx b/docs/models/taskclassificationresponse.mdx index b995ba16d..ea238a96a 100644 --- a/docs/models/taskclassificationresponse.mdx +++ b/docs/models/taskclassificationresponse.mdx @@ -45,4 +45,4 @@ let value: TaskClassificationResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `data` | [models.TaskClassificationResponseData](../models/taskclassificationresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.TaskClassificationResponseData](../models/taskclassificationresponsedata.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/taskclassificationresponsedata.mdx b/docs/models/taskclassificationresponsedata.mdx index 9a23a83b4..7d39cec20 100644 --- a/docs/models/taskclassificationresponsedata.mdx +++ b/docs/models/taskclassificationresponsedata.mdx @@ -48,7 +48,7 @@ let value: TaskClassificationResponseData = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `asOf` | *string* | :heavy_check_mark: | UTC date (YYYY-MM-DD) of the window upper bound (yesterday). Data is exclusive of the current incomplete UTC day. This is the expected latest date in the snapshot; it does not confirm data presence for that date. | 2026-06-17 | -| `classifications` | [models.TaskClassificationItem](../models/taskclassificationitem.mdx)[] | :heavy_check_mark: | Per-task classification market-share data, sorted by usage_share descending. | | -| `macroCategories` | [models.TaskClassificationMacroCategory](../models/taskclassificationmacrocategory.mdx)[] | :heavy_check_mark: | Aggregate market-share data per macro-category (code, data, agent, general). | | -| `windowDays` | *number* | :heavy_check_mark: | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file +| `asOf` | *string* | ✅ | UTC date (YYYY-MM-DD) of the window upper bound (yesterday). Data is exclusive of the current incomplete UTC day. This is the expected latest date in the snapshot; it does not confirm data presence for that date. | 2026-06-17 | +| `classifications` | [models.TaskClassificationItem](../models/taskclassificationitem.mdx)[] | ✅ | Per-task classification market-share data, sorted by usage_share descending. | | +| `macroCategories` | [models.TaskClassificationMacroCategory](../models/taskclassificationmacrocategory.mdx)[] | ✅ | Aggregate market-share data per macro-category (code, data, agent, general). | | +| `windowDays` | *number* | ✅ | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file diff --git a/docs/models/textdeltaevent.mdx b/docs/models/textdeltaevent.mdx index 182d80a07..912b6cd19 100644 --- a/docs/models/textdeltaevent.mdx +++ b/docs/models/textdeltaevent.mdx @@ -29,10 +29,10 @@ let value: TextDeltaEvent = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `delta` | *string* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `logprobs` | [models.StreamLogprob](../models/streamlogprob.mdx)[] | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.output_text.delta"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `contentIndex` | *number* | ✅ | N/A | +| `delta` | *string* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `logprobs` | [models.StreamLogprob](../models/streamlogprob.mdx)[] | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.output_text.delta"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/textdoneevent.mdx b/docs/models/textdoneevent.mdx index 02f6aad81..da8038c81 100644 --- a/docs/models/textdoneevent.mdx +++ b/docs/models/textdoneevent.mdx @@ -29,10 +29,10 @@ let value: TextDoneEvent = { | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `contentIndex` | *number* | :heavy_check_mark: | N/A | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `logprobs` | [models.StreamLogprob](../models/streamlogprob.mdx)[] | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `text` | *string* | :heavy_check_mark: | N/A | -| `type` | *"response.output_text.done"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `contentIndex` | *number* | ✅ | N/A | +| `itemId` | *string* | ✅ | N/A | +| `logprobs` | [models.StreamLogprob](../models/streamlogprob.mdx)[] | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `text` | *string* | ✅ | N/A | +| `type` | *"response.output_text.done"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/textextendedconfig.mdx b/docs/models/textextendedconfig.mdx index dd0fe65fe..dd0d85bc4 100644 --- a/docs/models/textextendedconfig.mdx +++ b/docs/models/textextendedconfig.mdx @@ -16,5 +16,5 @@ let value: TextExtendedConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `format` | *models.Formats* | :heavy_minus_sign: | Text response format configuration | \{
"type": "text"
} | -| `verbosity` | [models.Verbosity](../models/verbosity.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `format` | *models.Formats* | ➖ | Text response format configuration | \{
"type": "text"
} | +| `verbosity` | [models.Verbosity](../models/verbosity.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/textgeneration.mdx b/docs/models/textgeneration.mdx index 88603d114..bf23bdf81 100644 --- a/docs/models/textgeneration.mdx +++ b/docs/models/textgeneration.mdx @@ -28,6 +28,6 @@ let value: TextGeneration = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `requestCount` | *number* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `requestCount` | *number* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/thinkingadaptive.mdx b/docs/models/thinkingadaptive.mdx index ee0ad1dad..86bb3f68b 100644 --- a/docs/models/thinkingadaptive.mdx +++ b/docs/models/thinkingadaptive.mdx @@ -16,6 +16,6 @@ let value: ThinkingAdaptive = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `blockBinding` | [models.AnthropicThinkingBlockBinding](../models/anthropicthinkingblockbinding.mdx) | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `display` | [models.AnthropicThinkingDisplay](../models/anthropicthinkingdisplay.mdx) | :heavy_minus_sign: | N/A | summarized | -| `type` | *"adaptive"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `blockBinding` | [models.AnthropicThinkingBlockBinding](../models/anthropicthinkingblockbinding.mdx) | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `display` | [models.AnthropicThinkingDisplay](../models/anthropicthinkingdisplay.mdx) | ➖ | N/A | summarized | +| `type` | *"adaptive"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/thinkingbetweentools.mdx b/docs/models/thinkingbetweentools.mdx index 747502099..6da0995cc 100644 --- a/docs/models/thinkingbetweentools.mdx +++ b/docs/models/thinkingbetweentools.mdx @@ -16,4 +16,4 @@ let value: ThinkingBetweenTools = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"between_tools"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"between_tools"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/thinkingdisabled.mdx b/docs/models/thinkingdisabled.mdx index f9bb11862..559252a20 100644 --- a/docs/models/thinkingdisabled.mdx +++ b/docs/models/thinkingdisabled.mdx @@ -16,4 +16,4 @@ let value: ThinkingDisabled = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"disabled"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"disabled"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/thinkingenabled.mdx b/docs/models/thinkingenabled.mdx index c629c441c..7a683efe4 100644 --- a/docs/models/thinkingenabled.mdx +++ b/docs/models/thinkingenabled.mdx @@ -17,7 +17,7 @@ let value: ThinkingEnabled = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `blockBinding` | [models.AnthropicThinkingBlockBinding](../models/anthropicthinkingblockbinding.mdx) | :heavy_minus_sign: | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | -| `budgetTokens` | *number* | :heavy_check_mark: | N/A | | -| `display` | [models.AnthropicThinkingDisplay](../models/anthropicthinkingdisplay.mdx) | :heavy_minus_sign: | N/A | summarized | -| `type` | *"enabled"* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `blockBinding` | [models.AnthropicThinkingBlockBinding](../models/anthropicthinkingblockbinding.mdx) | ➖ | N/A | \{
"prefix_mismatch_behavior": "drop_block"
} | +| `budgetTokens` | *number* | ✅ | N/A | | +| `display` | [models.AnthropicThinkingDisplay](../models/anthropicthinkingdisplay.mdx) | ➖ | N/A | summarized | +| `type` | *"enabled"* | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/tokenexchangerequest.mdx b/docs/models/tokenexchangerequest.mdx index 4fd88c444..d76b56b1d 100644 --- a/docs/models/tokenexchangerequest.mdx +++ b/docs/models/tokenexchangerequest.mdx @@ -21,9 +21,9 @@ let value: TokenExchangeRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `federationPolicyId` | *string* | :heavy_check_mark: | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | -| `grantType` | [models.GrantType](../models/granttype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | -| `requestedTokenType` | [models.RequestedTokenType](../models/requestedtokentype.mdx) | :heavy_minus_sign: | Optional; when present must be `urn:ietf:params:oauth:token-type:access_token`. | urn:ietf:params:oauth:token-type:access_token | -| `scope` | [models.TokenExchangeRequestScope](../models/tokenexchangerequestscope.mdx) | :heavy_minus_sign: | Optional; only `inference` is available. | inference | -| `subjectToken` | *string* | :heavy_check_mark: | The JWT issued by your identity provider. | \ | -| `subjectTokenType` | [models.SubjectTokenType](../models/subjecttokentype.mdx) | :heavy_check_mark: | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | \ No newline at end of file +| `federationPolicyId` | *string* | ✅ | The federation policy to evaluate, from Settings → Workload identity. Binds the exchange to one organization. | 4b2f7d1e-8c3a-4e5f-9a6b-1c2d3e4f5a6b | +| `grantType` | [models.GrantType](../models/granttype.mdx) | ✅ | Must be `urn:ietf:params:oauth:grant-type:token-exchange`. | urn:ietf:params:oauth:grant-type:token-exchange | +| `requestedTokenType` | [models.RequestedTokenType](../models/requestedtokentype.mdx) | ➖ | Optional; when present must be `urn:ietf:params:oauth:token-type:access_token`. | urn:ietf:params:oauth:token-type:access_token | +| `scope` | [models.TokenExchangeRequestScope](../models/tokenexchangerequestscope.mdx) | ➖ | Optional; only `inference` is available. | inference | +| `subjectToken` | *string* | ✅ | The JWT issued by your identity provider. | \ | +| `subjectTokenType` | [models.SubjectTokenType](../models/subjecttokentype.mdx) | ✅ | Must be `urn:ietf:params:oauth:token-type:jwt`. | urn:ietf:params:oauth:token-type:jwt | \ No newline at end of file diff --git a/docs/models/tokenexchangeresponse.mdx b/docs/models/tokenexchangeresponse.mdx index 4e3766081..bfa61839a 100644 --- a/docs/models/tokenexchangeresponse.mdx +++ b/docs/models/tokenexchangeresponse.mdx @@ -22,8 +22,8 @@ let value: TokenExchangeResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `accessToken` | *string* | :heavy_check_mark: | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | -| `expiresIn` | *number* | :heavy_check_mark: | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | -| `issuedTokenType` | [models.IssuedTokenType](../models/issuedtokentype.mdx) | :heavy_check_mark: | N/A | urn:ietf:params:oauth:token-type:access_token | -| `scope` | *string* | :heavy_check_mark: | N/A | inference | -| `tokenType` | [models.TokenType](../models/tokentype.mdx) | :heavy_check_mark: | N/A | Bearer | \ No newline at end of file +| `accessToken` | *string* | ✅ | A short-lived JWT to send as `Authorization: Bearer` to the inference API. | \ | +| `expiresIn` | *number* | ✅ | Seconds until the access token expires: at most 15 minutes, and never later than the subject token expires. | 900 | +| `issuedTokenType` | [models.IssuedTokenType](../models/issuedtokentype.mdx) | ✅ | N/A | urn:ietf:params:oauth:token-type:access_token | +| `scope` | *string* | ✅ | N/A | inference | +| `tokenType` | [models.TokenType](../models/tokentype.mdx) | ✅ | N/A | Bearer | \ No newline at end of file diff --git a/docs/models/tooladvisor20260301.mdx b/docs/models/tooladvisor20260301.mdx index 060f636c6..40a6e464e 100644 --- a/docs/models/tooladvisor20260301.mdx +++ b/docs/models/tooladvisor20260301.mdx @@ -18,11 +18,11 @@ let value: ToolAdvisor20260301 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `caching` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | N/A | \{
"type": "ephemeral"
} | -| `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | -| `maxUses` | *number* | :heavy_minus_sign: | N/A | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `name` | [models.NameAdvisor](../models/nameadvisor.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeAdvisor20260301](../models/typeadvisor20260301.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | ➖ | N/A | [
"direct"
] | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `caching` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | N/A | \{
"type": "ephemeral"
} | +| `deferLoading` | *boolean* | ➖ | N/A | | +| `maxUses` | *number* | ➖ | N/A | | +| `model` | *string* | ✅ | N/A | | +| `name` | [models.NameAdvisor](../models/nameadvisor.mdx) | ✅ | N/A | | +| `type` | [models.TypeAdvisor20260301](../models/typeadvisor20260301.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/toolbash20250124.mdx b/docs/models/toolbash20250124.mdx index 78b851952..1d058db5c 100644 --- a/docs/models/toolbash20250124.mdx +++ b/docs/models/toolbash20250124.mdx @@ -17,6 +17,6 @@ let value: ToolBash20250124 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `name` | [models.NameBash](../models/namebash.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeBash20250124](../models/typebash20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `name` | [models.NameBash](../models/namebash.mdx) | ✅ | N/A | | +| `type` | [models.TypeBash20250124](../models/typebash20250124.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/toolcall.mdx b/docs/models/toolcall.mdx index 02b95fb1a..24ee50e44 100644 --- a/docs/models/toolcall.mdx +++ b/docs/models/toolcall.mdx @@ -22,7 +22,7 @@ let value: ToolCall = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `function` | [models.BatchObjectFunction](../models/batchobjectfunction.mdx) | :heavy_check_mark: | N/A | -| `id` | *string* | :heavy_check_mark: | N/A | -| `index` | *number* | :heavy_check_mark: | N/A | -| `type` | [models.ChoiceTypeFunction](../models/choicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `function` | [models.BatchObjectFunction](../models/batchobjectfunction.mdx) | ✅ | N/A | +| `id` | *string* | ✅ | N/A | +| `index` | *number* | ✅ | N/A | +| `type` | [models.ChoiceTypeFunction](../models/choicetypefunction.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/toolchoiceallowed.mdx b/docs/models/toolchoiceallowed.mdx index 36569b68e..97a5bd23e 100644 --- a/docs/models/toolchoiceallowed.mdx +++ b/docs/models/toolchoiceallowed.mdx @@ -25,6 +25,6 @@ let value: ToolChoiceAllowed = { | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `mode` | *models.Mode* | :heavy_check_mark: | N/A | -| `tools` | Record\[] | :heavy_check_mark: | N/A | -| `type` | [models.ToolChoiceAllowedType](../models/toolchoiceallowedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `mode` | *models.Mode* | ✅ | N/A | +| `tools` | Record\[] | ✅ | N/A | +| `type` | [models.ToolChoiceAllowedType](../models/toolchoiceallowedtype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/toolchoiceany.mdx b/docs/models/toolchoiceany.mdx index 784be06c4..ddec48887 100644 --- a/docs/models/toolchoiceany.mdx +++ b/docs/models/toolchoiceany.mdx @@ -16,5 +16,5 @@ let value: ToolChoiceAny = { | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `disableParallelToolUse` | *boolean* | :heavy_minus_sign: | N/A | -| `type` | *"any"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `disableParallelToolUse` | *boolean* | ➖ | N/A | +| `type` | *"any"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/toolchoiceauto.mdx b/docs/models/toolchoiceauto.mdx index 44657d8e8..6b050dbe7 100644 --- a/docs/models/toolchoiceauto.mdx +++ b/docs/models/toolchoiceauto.mdx @@ -16,5 +16,5 @@ let value: ToolChoiceAuto = { | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `disableParallelToolUse` | *boolean* | :heavy_minus_sign: | N/A | -| `type` | *"auto"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `disableParallelToolUse` | *boolean* | ➖ | N/A | +| `type` | *"auto"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/toolchoicenone.mdx b/docs/models/toolchoicenone.mdx index 82b1dbff4..2f85bcf9e 100644 --- a/docs/models/toolchoicenone.mdx +++ b/docs/models/toolchoicenone.mdx @@ -16,4 +16,4 @@ let value: ToolChoiceNone = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `type` | *"none"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | *"none"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/toolchoicesupport.mdx b/docs/models/toolchoicesupport.mdx index 359fc6f98..c97d25fb0 100644 --- a/docs/models/toolchoicesupport.mdx +++ b/docs/models/toolchoicesupport.mdx @@ -21,7 +21,7 @@ let value: ToolChoiceSupport = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `auto` | *boolean* | :heavy_check_mark: | Whether the endpoint supports `"tool_choice": "auto"`. | -| `function` | *boolean* | :heavy_check_mark: | Whether the endpoint supports naming a function, `"tool_choice": {"type": "function", ...}`. | -| `none` | *boolean* | :heavy_check_mark: | Whether the endpoint supports `"tool_choice": "none"`. | -| `required` | *boolean* | :heavy_check_mark: | Whether the endpoint supports `"tool_choice": "required"`. | \ No newline at end of file +| `auto` | *boolean* | ✅ | Whether the endpoint supports `"tool_choice": "auto"`. | +| `function` | *boolean* | ✅ | Whether the endpoint supports naming a function, `"tool_choice": {"type": "function", ...}`. | +| `none` | *boolean* | ✅ | Whether the endpoint supports `"tool_choice": "none"`. | +| `required` | *boolean* | ✅ | Whether the endpoint supports `"tool_choice": "required"`. | \ No newline at end of file diff --git a/docs/models/toolchoicetool.mdx b/docs/models/toolchoicetool.mdx index 4861bb6ed..1b479356b 100644 --- a/docs/models/toolchoicetool.mdx +++ b/docs/models/toolchoicetool.mdx @@ -17,6 +17,6 @@ let value: ToolChoiceTool = { | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `disableParallelToolUse` | *boolean* | :heavy_minus_sign: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `type` | *"tool"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `disableParallelToolUse` | *boolean* | ➖ | N/A | +| `name` | *string* | ✅ | N/A | +| `type` | *"tool"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/toolcustom.mdx b/docs/models/toolcustom.mdx index a0994d1ae..3f6831424 100644 --- a/docs/models/toolcustom.mdx +++ b/docs/models/toolcustom.mdx @@ -17,10 +17,10 @@ let value: ToolCustom = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `deferLoading` | *boolean* | :heavy_minus_sign: | N/A | | -| `description` | *string* | :heavy_minus_sign: | N/A | | -| `inputSchema` | [models.InputSchema](../models/inputschema.mdx) | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | | -| `strict` | *boolean* | :heavy_minus_sign: | N/A | | -| `type` | [models.ToolTypeCustom](../models/tooltypecustom.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `deferLoading` | *boolean* | ➖ | N/A | | +| `description` | *string* | ➖ | N/A | | +| `inputSchema` | [models.InputSchema](../models/inputschema.mdx) | ✅ | N/A | | +| `name` | *string* | ✅ | N/A | | +| `strict` | *boolean* | ➖ | N/A | | +| `type` | [models.ToolTypeCustom](../models/tooltypecustom.mdx) | ➖ | N/A | | \ No newline at end of file diff --git a/docs/models/toolsearchservertool.mdx b/docs/models/toolsearchservertool.mdx index 7a0570b0a..835582a8e 100644 --- a/docs/models/toolsearchservertool.mdx +++ b/docs/models/toolsearchservertool.mdx @@ -18,5 +18,5 @@ let value: ToolSearchServerTool = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `parameters` | [models.ToolSearchServerToolConfig](../models/toolsearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | -| `type` | [models.ToolSearchServerToolType](../models/toolsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.ToolSearchServerToolConfig](../models/toolsearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:tool_search server tool | \{
"max_results": 5
} | +| `type` | [models.ToolSearchServerToolType](../models/toolsearchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/toolsearchservertoolconfig.mdx b/docs/models/toolsearchservertoolconfig.mdx index eeb507e14..105254c99 100644 --- a/docs/models/toolsearchservertoolconfig.mdx +++ b/docs/models/toolsearchservertoolconfig.mdx @@ -16,4 +16,4 @@ let value: ToolSearchServerToolConfig = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file +| `maxResults` | *number* | ➖ | Maximum tools returned by one search. Defaults to 5. | 5 | \ No newline at end of file diff --git a/docs/models/tooltexteditor20250124.mdx b/docs/models/tooltexteditor20250124.mdx index 9b821dc85..19a5161c6 100644 --- a/docs/models/tooltexteditor20250124.mdx +++ b/docs/models/tooltexteditor20250124.mdx @@ -17,6 +17,6 @@ let value: ToolTextEditor20250124 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `name` | [models.NameStrReplaceEditor](../models/namestrreplaceeditor.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeTextEditor20250124](../models/typetexteditor20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `name` | [models.NameStrReplaceEditor](../models/namestrreplaceeditor.mdx) | ✅ | N/A | | +| `type` | [models.TypeTextEditor20250124](../models/typetexteditor20250124.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/toolwebsearch20250305.mdx b/docs/models/toolwebsearch20250305.mdx index e39bf6779..d6bd39657 100644 --- a/docs/models/toolwebsearch20250305.mdx +++ b/docs/models/toolwebsearch20250305.mdx @@ -17,10 +17,10 @@ let value: ToolWebSearch20250305 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `blockedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `maxUses` | *number* | :heavy_minus_sign: | N/A | | -| `name` | [models.NameWebSearch1](../models/namewebsearch1.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeWebSearch20250305](../models/typewebsearch20250305.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.AnthropicWebSearchToolUserLocation](../models/anthropicwebsearchtooluserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `allowedDomains` | *string*[] | ➖ | N/A | | +| `blockedDomains` | *string*[] | ➖ | N/A | | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `maxUses` | *number* | ➖ | N/A | | +| `name` | [models.NameWebSearch1](../models/namewebsearch1.mdx) | ✅ | N/A | | +| `type` | [models.TypeWebSearch20250305](../models/typewebsearch20250305.mdx) | ✅ | N/A | | +| `userLocation` | [models.AnthropicWebSearchToolUserLocation](../models/anthropicwebsearchtooluserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/toolwebsearch20260209.mdx b/docs/models/toolwebsearch20260209.mdx index 3934627a7..dbad0654e 100644 --- a/docs/models/toolwebsearch20260209.mdx +++ b/docs/models/toolwebsearch20260209.mdx @@ -17,11 +17,11 @@ let value: ToolWebSearch20260209 = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | :heavy_minus_sign: | N/A | [
"direct"
] | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `blockedDomains` | *string*[] | :heavy_minus_sign: | N/A | | -| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | :heavy_minus_sign: | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | -| `maxUses` | *number* | :heavy_minus_sign: | N/A | | -| `name` | [models.NameWebSearch2](../models/namewebsearch2.mdx) | :heavy_check_mark: | N/A | | -| `type` | [models.TypeWebSearch20260209](../models/typewebsearch20260209.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.AnthropicWebSearchToolUserLocation](../models/anthropicwebsearchtooluserlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `allowedCallers` | [models.AnthropicAllowedCallers](../models/anthropicallowedcallers.mdx)[] | ➖ | N/A | [
"direct"
] | +| `allowedDomains` | *string*[] | ➖ | N/A | | +| `blockedDomains` | *string*[] | ➖ | N/A | | +| `cacheControl` | [models.AnthropicCacheControlDirective](../models/anthropiccachecontroldirective.mdx) | ➖ | Enable automatic prompt caching. When set at the top level, the system automatically applies cache breakpoints to the last cacheable block in the request. When set on an individual content block, it marks an explicit cache breakpoint; block-level markers also work on OpenAI models that support explicit prompt caching — OpenRouter converts them to the provider's native format. | \{
"type": "ephemeral"
} | +| `maxUses` | *number* | ➖ | N/A | | +| `name` | [models.NameWebSearch2](../models/namewebsearch2.mdx) | ✅ | N/A | | +| `type` | [models.TypeWebSearch20260209](../models/typewebsearch20260209.mdx) | ✅ | N/A | | +| `userLocation` | [models.AnthropicWebSearchToolUserLocation](../models/anthropicwebsearchtooluserlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/toomanyrequestsresponseerrordata.mdx b/docs/models/toomanyrequestsresponseerrordata.mdx index f0e2b0bab..e36cb985b 100644 --- a/docs/models/toomanyrequestsresponseerrordata.mdx +++ b/docs/models/toomanyrequestsresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: TooManyRequestsResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/topproviderinfo.mdx b/docs/models/topproviderinfo.mdx index 81362bdb1..c9d773dbd 100644 --- a/docs/models/topproviderinfo.mdx +++ b/docs/models/topproviderinfo.mdx @@ -18,6 +18,6 @@ let value: TopProviderInfo = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contextLength` | *number* | :heavy_minus_sign: | Context length from the top provider | 8192 | -| `isModerated` | *boolean* | :heavy_check_mark: | Whether the top provider moderates content | true | -| `maxCompletionTokens` | *number* | :heavy_minus_sign: | Maximum completion tokens from the top provider. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | 4096 | \ No newline at end of file +| `contextLength` | *number* | ➖ | Context length from the top provider | 8192 | +| `isModerated` | *boolean* | ✅ | Whether the top provider moderates content | true | +| `maxCompletionTokens` | *number* | ➖ | Maximum completion tokens from the top provider. Input and output tokens share the context window, so the effective maximum output for a request is further limited by the context remaining after input tokens. | 4096 | \ No newline at end of file diff --git a/docs/models/tournamentstats.mdx b/docs/models/tournamentstats.mdx index 599fe85c7..26c5ae06f 100644 --- a/docs/models/tournamentstats.mdx +++ b/docs/models/tournamentstats.mdx @@ -22,8 +22,8 @@ let value: TournamentStats = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `firstPlace` | *number* | :heavy_check_mark: | N/A | -| `fourthPlace` | *number* | :heavy_check_mark: | N/A | -| `secondPlace` | *number* | :heavy_check_mark: | N/A | -| `thirdPlace` | *number* | :heavy_check_mark: | N/A | -| `total` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `firstPlace` | *number* | ✅ | N/A | +| `fourthPlace` | *number* | ✅ | N/A | +| `secondPlace` | *number* | ✅ | N/A | +| `thirdPlace` | *number* | ✅ | N/A | +| `total` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/traceconfig.mdx b/docs/models/traceconfig.mdx index face24c89..452e7ec31 100644 --- a/docs/models/traceconfig.mdx +++ b/docs/models/traceconfig.mdx @@ -16,9 +16,9 @@ let value: TraceConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `generationName` | *string* | :heavy_minus_sign: | N/A | | -| `parentSpanId` | *string* | :heavy_minus_sign: | N/A | | -| `spanName` | *string* | :heavy_minus_sign: | N/A | | -| `traceId` | *string* | :heavy_minus_sign: | N/A | | -| `traceName` | *string* | :heavy_minus_sign: | N/A | | -| `additionalProperties` | Record\ | :heavy_minus_sign: | N/A | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | \ No newline at end of file +| `generationName` | *string* | ➖ | N/A | | +| `parentSpanId` | *string* | ➖ | N/A | | +| `spanName` | *string* | ➖ | N/A | | +| `traceId` | *string* | ➖ | N/A | | +| `traceName` | *string* | ➖ | N/A | | +| `additionalProperties` | Record\ | ➖ | N/A | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | \ No newline at end of file diff --git a/docs/models/triggerinputtokens.mdx b/docs/models/triggerinputtokens.mdx index 007b8789e..f37fd1c57 100644 --- a/docs/models/triggerinputtokens.mdx +++ b/docs/models/triggerinputtokens.mdx @@ -17,5 +17,5 @@ let value: TriggerInputTokens = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `type` | [models.EditTypeInputTokens](../models/edittypeinputtokens.mdx) | :heavy_check_mark: | N/A | -| `value` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.EditTypeInputTokens](../models/edittypeinputtokens.mdx) | ✅ | N/A | +| `value` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/tts.mdx b/docs/models/tts.mdx index 4ed525e27..94f97f733 100644 --- a/docs/models/tts.mdx +++ b/docs/models/tts.mdx @@ -28,6 +28,6 @@ let value: TTS = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `requestCount` | *number* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `requestCount` | *number* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/unauthorizedresponseerrordata.mdx b/docs/models/unauthorizedresponseerrordata.mdx index f9f83d1cb..deaf6d9e0 100644 --- a/docs/models/unauthorizedresponseerrordata.mdx +++ b/docs/models/unauthorizedresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: UnauthorizedResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarkpricing.mdx b/docs/models/unifiedbenchmarkpricing.mdx index ce6edf3cb..7c072e1e1 100644 --- a/docs/models/unifiedbenchmarkpricing.mdx +++ b/docs/models/unifiedbenchmarkpricing.mdx @@ -19,5 +19,5 @@ let value: UnifiedBenchmarkPricing = { | Field | Type | Required | Description | Example | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `completion` | *string* | :heavy_check_mark: | Cost per output token (USD, decimal string). | 0.000015 | -| `prompt` | *string* | :heavy_check_mark: | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file +| `completion` | *string* | ✅ | Cost per output token (USD, decimal string). | 0.000015 | +| `prompt` | *string* | ✅ | Cost per input token (USD, decimal string). | 0.000003 | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarksaaitem.mdx b/docs/models/unifiedbenchmarksaaitem.mdx index 345f79bbf..3933a2e78 100644 --- a/docs/models/unifiedbenchmarksaaitem.mdx +++ b/docs/models/unifiedbenchmarksaaitem.mdx @@ -25,10 +25,10 @@ let value: UnifiedBenchmarksAAItem = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `agenticIndex` | *number* | :heavy_check_mark: | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | -| `codingIndex` | *number* | :heavy_check_mark: | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | -| `displayName` | *string* | :heavy_check_mark: | Model name as listed on Artificial Analysis. | GPT-4o | -| `intelligenceIndex` | *number* | :heavy_check_mark: | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | -| `modelPermaslug` | *string* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `pricing` | [models.UnifiedBenchmarkPricing](../models/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `source` | [models.UnifiedBenchmarksAAItemSource](../models/unifiedbenchmarksaaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | \ No newline at end of file +| `agenticIndex` | *number* | ✅ | Artificial Analysis Agentic Index composite score. Higher is better. | 58.3 | +| `codingIndex` | *number* | ✅ | Artificial Analysis Coding Index composite score. Higher is better. | 65.8 | +| `displayName` | *string* | ✅ | Model name as listed on Artificial Analysis. | GPT-4o | +| `intelligenceIndex` | *number* | ✅ | Artificial Analysis Intelligence Index composite score. Higher is better. | 71.2 | +| `modelPermaslug` | *string* | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | +| `pricing` | [models.UnifiedBenchmarkPricing](../models/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `source` | [models.UnifiedBenchmarksAAItemSource](../models/unifiedbenchmarksaaitemsource.mdx) | ✅ | Benchmark source discriminator. | | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarksdaitem.mdx b/docs/models/unifiedbenchmarksdaitem.mdx index c76cd69c0..b7e22194e 100644 --- a/docs/models/unifiedbenchmarksdaitem.mdx +++ b/docs/models/unifiedbenchmarksdaitem.mdx @@ -34,13 +34,13 @@ let value: UnifiedBenchmarksDAItem = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `arena` | *string* | :heavy_check_mark: | Arena this ranking belongs to. | models | -| `avgGenerationTimeMs` | *number* | :heavy_check_mark: | Average generation time in milliseconds. | 3200 | -| `category` | *string* | :heavy_check_mark: | Category within the arena. | codecategories | -| `displayName` | *string* | :heavy_check_mark: | Human-readable model name from Design Arena. | Claude Sonnet 4 | -| `elo` | *number* | :heavy_check_mark: | ELO rating from head-to-head arena battles. | 1423 | -| `modelPermaslug` | *string* | :heavy_check_mark: | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | -| `pricing` | [models.UnifiedBenchmarkPricing](../models/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `source` | [models.UnifiedBenchmarksDAItemSource](../models/unifiedbenchmarksdaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `tournamentStats` | [models.TournamentStats](../models/tournamentstats.mdx) | :heavy_check_mark: | Placement distribution from tournament matches. | | -| `winRate` | *number* | :heavy_check_mark: | Win rate as a percentage (0–100). | 72 | \ No newline at end of file +| `arena` | *string* | ✅ | Arena this ranking belongs to. | models | +| `avgGenerationTimeMs` | *number* | ✅ | Average generation time in milliseconds. | 3200 | +| `category` | *string* | ✅ | Category within the arena. | codecategories | +| `displayName` | *string* | ✅ | Human-readable model name from Design Arena. | Claude Sonnet 4 | +| `elo` | *number* | ✅ | ELO rating from head-to-head arena battles. | 1423 | +| `modelPermaslug` | *string* | ✅ | Stable OpenRouter model identifier when mapped; otherwise the upstream Design Arena model id. | anthropic/claude-sonnet-4 | +| `pricing` | [models.UnifiedBenchmarkPricing](../models/unifiedbenchmarkpricing.mdx) | ✅ | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `source` | [models.UnifiedBenchmarksDAItemSource](../models/unifiedbenchmarksdaitemsource.mdx) | ✅ | Benchmark source discriminator. | | +| `tournamentStats` | [models.TournamentStats](../models/tournamentstats.mdx) | ✅ | Placement distribution from tournament matches. | | +| `winRate` | *number* | ✅ | Win rate as a percentage (0–100). | 72 | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarksmeta.mdx b/docs/models/unifiedbenchmarksmeta.mdx index 8d8c3648f..f8f4e93a5 100644 --- a/docs/models/unifiedbenchmarksmeta.mdx +++ b/docs/models/unifiedbenchmarksmeta.mdx @@ -23,10 +23,10 @@ let value: UnifiedBenchmarksMeta = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `asOf` | *string* | :heavy_check_mark: | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | -| `citation` | *string* | :heavy_check_mark: | Required attribution when republishing this data, or null when results span multiple sources (attribute each item individually by its `source` discriminator). | Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings). | -| `modelCount` | *number* | :heavy_check_mark: | Number of unique models in the response. | | -| `source` | [models.UnifiedBenchmarksMetaSource](../models/unifiedbenchmarksmetasource.mdx) | :heavy_check_mark: | The source filter applied, or null when all sources are returned. | artificial-analysis | -| `sourceUrl` | *string* | :heavy_check_mark: | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | -| `taskType` | *string* | :heavy_check_mark: | The task_type filter applied, or null if showing all. | | -| `version` | [models.UnifiedBenchmarksMetaVersion](../models/unifiedbenchmarksmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | \ No newline at end of file +| `asOf` | *string* | ✅ | ISO-8601 timestamp of when this data was last updated. | 2026-06-03T12:00:00Z | +| `citation` | *string* | ✅ | Required attribution when republishing this data, or null when results span multiple sources (attribute each item individually by its `source` discriminator). | Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings). | +| `modelCount` | *number* | ✅ | Number of unique models in the response. | | +| `source` | [models.UnifiedBenchmarksMetaSource](../models/unifiedbenchmarksmetasource.mdx) | ✅ | The source filter applied, or null when all sources are returned. | artificial-analysis | +| `sourceUrl` | *string* | ✅ | URL of the upstream data source, or null when results span multiple sources. | https://artificialanalysis.ai | +| `taskType` | *string* | ✅ | The task_type filter applied, or null if showing all. | | +| `version` | [models.UnifiedBenchmarksMetaVersion](../models/unifiedbenchmarksmetaversion.mdx) | ✅ | Dataset version. | | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarksoritem.mdx b/docs/models/unifiedbenchmarksoritem.mdx index c3bf00cac..39d5e04ab 100644 --- a/docs/models/unifiedbenchmarksoritem.mdx +++ b/docs/models/unifiedbenchmarksoritem.mdx @@ -24,12 +24,12 @@ let value: UnifiedBenchmarksORItem = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `accuracy` | *number* | :heavy_check_mark: | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | -| `accuracyStddev` | *number* | :heavy_check_mark: | Standard deviation of run accuracy, or null for a single run. | 0.03 | -| `avgCostPerTask` | *number* | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.002 | -| `benchmarkType` | [models.UnifiedBenchmarksORItemBenchmarkType](../models/unifiedbenchmarksoritembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter benchmark evaluation type. | gpqa_diamond | -| `displayName` | *string* | :heavy_check_mark: | Human-readable model name. | GPT-4o | -| `lastRunTimestamp` | *string* | :heavy_check_mark: | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | -| `modelPermaslug` | *string* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `source` | [models.UnifiedBenchmarksORItemSource](../models/unifiedbenchmarksoritemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `totalTasks` | *number* | :heavy_check_mark: | Total benchmark tasks across runs. | 300 | \ No newline at end of file +| `accuracy` | *number* | ✅ | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | +| `accuracyStddev` | *number* | ✅ | Standard deviation of run accuracy, or null for a single run. | 0.03 | +| `avgCostPerTask` | *number* | ✅ | Average cost per task in USD, or null if unavailable. | 0.002 | +| `benchmarkType` | [models.UnifiedBenchmarksORItemBenchmarkType](../models/unifiedbenchmarksoritembenchmarktype.mdx) | ✅ | OpenRouter benchmark evaluation type. | gpqa_diamond | +| `displayName` | *string* | ✅ | Human-readable model name. | GPT-4o | +| `lastRunTimestamp` | *string* | ✅ | Timestamp of the most recent public benchmark run. | 2026-06-03T12:00:00Z | +| `modelPermaslug` | *string* | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | +| `source` | [models.UnifiedBenchmarksORItemSource](../models/unifiedbenchmarksoritemsource.mdx) | ✅ | Benchmark source discriminator. | | +| `totalTasks` | *number* | ✅ | Total benchmark tasks across runs. | 300 | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarksresponse.mdx b/docs/models/unifiedbenchmarksresponse.mdx index 7c066a570..2f60dd693 100644 --- a/docs/models/unifiedbenchmarksresponse.mdx +++ b/docs/models/unifiedbenchmarksresponse.mdx @@ -49,5 +49,5 @@ let value: UnifiedBenchmarksResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *models.UnifiedBenchmarksResponseData*[] | :heavy_check_mark: | N/A | | -| `meta` | [models.UnifiedBenchmarksMeta](../models/unifiedbenchmarksmeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-06-03T12:00:00Z",
"citation": "Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings).",
"model_count": 50,
"source": "artificial-analysis",
"source_url": "https://artificialanalysis.ai",
"task_type": null,
"version": "v1"
} | \ No newline at end of file +| `data` | *models.UnifiedBenchmarksResponseData*[] | ✅ | N/A | | +| `meta` | [models.UnifiedBenchmarksMeta](../models/unifiedbenchmarksmeta.mdx) | ✅ | N/A | \{
"as_of": "2026-06-03T12:00:00Z",
"citation": "Source: Artificial Analysis (artificialanalysis.ai) via OpenRouter (openrouter.ai/rankings).",
"model_count": 50,
"source": "artificial-analysis",
"source_url": "https://artificialanalysis.ai",
"task_type": null,
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarkssearchitem.mdx b/docs/models/unifiedbenchmarkssearchitem.mdx index bc70ef0ea..1434832bd 100644 --- a/docs/models/unifiedbenchmarkssearchitem.mdx +++ b/docs/models/unifiedbenchmarkssearchitem.mdx @@ -27,16 +27,16 @@ let value: UnifiedBenchmarksSearchItem = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `avgCostPerTask` | *number* | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.031 | -| `avgLatencyPerTaskMs` | *number* | :heavy_check_mark: | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | -| `benchmarkType` | [models.UnifiedBenchmarksSearchItemBenchmarkType](../models/unifiedbenchmarkssearchitembenchmarktype.mdx) | :heavy_check_mark: | OpenRouter search benchmark. | search_browsecomp | -| `displayName` | *string* | :heavy_check_mark: | Human-readable model name. | GPT-4o | -| `lastRunTimestamp` | *string* | :heavy_check_mark: | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | -| `modelPermaslug` | *string* | :heavy_check_mark: | Stable OpenRouter model identifier. | openai/gpt-4o | -| `primaryMetric` | [models.PrimaryMetric](../models/primarymetric.mdx) | :heavy_check_mark: | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | -| `primaryScore` | *number* | :heavy_check_mark: | The benchmark's headline score from 0 to 1. Its meaning is identified by `primary_metric`: item-weighted F1 for WideSearch or strict accuracy for the other search benchmarks. Higher is better. | 0.72 | -| `runConfig` | [models.UnifiedBenchmarksSearchRunConfig](../models/unifiedbenchmarkssearchrunconfig.mdx) | :heavy_minus_sign: | Published lane configuration, included only when include_run_config=true. Only the agent turn count, reasoning effort, and temperature are exposed; other harness settings are intentionally not part of the public contract. | | -| `searchEngine` | *string* | :heavy_check_mark: | Search engine the published configuration used. | exa | -| `searchSurface` | [models.SearchSurface](../models/searchsurface.mdx) | :heavy_check_mark: | Request surface the published configuration went through. | server-tool | -| `source` | [models.UnifiedBenchmarksSearchItemSource](../models/unifiedbenchmarkssearchitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `totalTasks` | *number* | :heavy_check_mark: | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file +| `avgCostPerTask` | *number* | ✅ | Average cost per task in USD, or null if unavailable. | 0.031 | +| `avgLatencyPerTaskMs` | *number* | ✅ | Average wall-clock latency per task in milliseconds, or null if unavailable. | 45210 | +| `benchmarkType` | [models.UnifiedBenchmarksSearchItemBenchmarkType](../models/unifiedbenchmarkssearchitembenchmarktype.mdx) | ✅ | OpenRouter search benchmark. | search_browsecomp | +| `displayName` | *string* | ✅ | Human-readable model name. | GPT-4o | +| `lastRunTimestamp` | *string* | ✅ | Timestamp of the newest qualifying run in the published configuration's lane. | 2026-07-28T13:38:18Z | +| `modelPermaslug` | *string* | ✅ | Stable OpenRouter model identifier. | openai/gpt-4o | +| `primaryMetric` | [models.PrimaryMetric](../models/primarymetric.mdx) | ✅ | Identifies the meaning of `primary_score`: `f1_by_item` for WideSearch, `accuracy` for all other search benchmarks. | accuracy | +| `primaryScore` | *number* | ✅ | The benchmark's headline score from 0 to 1. Its meaning is identified by `primary_metric`: item-weighted F1 for WideSearch or strict accuracy for the other search benchmarks. Higher is better. | 0.72 | +| `runConfig` | [models.UnifiedBenchmarksSearchRunConfig](../models/unifiedbenchmarkssearchrunconfig.mdx) | ➖ | Published lane configuration, included only when include_run_config=true. Only the agent turn count, reasoning effort, and temperature are exposed; other harness settings are intentionally not part of the public contract. | | +| `searchEngine` | *string* | ✅ | Search engine the published configuration used. | exa | +| `searchSurface` | [models.SearchSurface](../models/searchsurface.mdx) | ✅ | Request surface the published configuration went through. | server-tool | +| `source` | [models.UnifiedBenchmarksSearchItemSource](../models/unifiedbenchmarkssearchitemsource.mdx) | ✅ | Benchmark source discriminator. | | +| `totalTasks` | *number* | ✅ | Tasks evaluated across the published configuration's runs. | 100 | \ No newline at end of file diff --git a/docs/models/unifiedbenchmarkssearchrunconfig.mdx b/docs/models/unifiedbenchmarkssearchrunconfig.mdx index bdc732d52..d914a84f7 100644 --- a/docs/models/unifiedbenchmarkssearchrunconfig.mdx +++ b/docs/models/unifiedbenchmarkssearchrunconfig.mdx @@ -20,6 +20,6 @@ let value: UnifiedBenchmarksSearchRunConfig = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `maxAgentTurns` | *number* | :heavy_check_mark: | Agent-turn count for the published lane, or null for plugin lanes. | 25 | -| `reasoningEffort` | *string* | :heavy_check_mark: | Reasoning effort configured for the published lane, or null when omitted. | high | -| `temperature` | *number* | :heavy_check_mark: | Sampling temperature configured for the published lane, or null when omitted. | 0.2 | \ No newline at end of file +| `maxAgentTurns` | *number* | ✅ | Agent-turn count for the published lane, or null for plugin lanes. | 25 | +| `reasoningEffort` | *string* | ✅ | Reasoning effort configured for the published lane, or null when omitted. | high | +| `temperature` | *number* | ✅ | Sampling temperature configured for the published lane, or null when omitted. | 0.2 | \ No newline at end of file diff --git a/docs/models/uniqueinsight.mdx b/docs/models/uniqueinsight.mdx index 3c6e5199f..4636facef 100644 --- a/docs/models/uniqueinsight.mdx +++ b/docs/models/uniqueinsight.mdx @@ -17,5 +17,5 @@ let value: UniqueInsight = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `insight` | *string* | :heavy_check_mark: | N/A | -| `model` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `insight` | *string* | ✅ | N/A | +| `model` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/unknown.mdx b/docs/models/unknown.mdx index 270af7492..3798a0de3 100644 --- a/docs/models/unknown.mdx +++ b/docs/models/unknown.mdx @@ -28,6 +28,6 @@ let value: Unknown = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `requestCount` | *number* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `requestCount` | *number* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/unprocessableentityresponseerrordata.mdx b/docs/models/unprocessableentityresponseerrordata.mdx index 9f0085012..9ceeca44d 100644 --- a/docs/models/unprocessableentityresponseerrordata.mdx +++ b/docs/models/unprocessableentityresponseerrordata.mdx @@ -19,6 +19,6 @@ let value: UnprocessableEntityResponseErrorData = { | Field | Type | Required | Description | | --------------------- | --------------------- | --------------------- | --------------------- | -| `code` | *number* | :heavy_check_mark: | N/A | -| `message` | *string* | :heavy_check_mark: | N/A | -| `metadata` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `code` | *number* | ✅ | N/A | +| `message` | *string* | ✅ | N/A | +| `metadata` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/updatebyokkeyrequest.mdx b/docs/models/updatebyokkeyrequest.mdx index aef70f642..53713bb47 100644 --- a/docs/models/updatebyokkeyrequest.mdx +++ b/docs/models/updatebyokkeyrequest.mdx @@ -14,14 +14,14 @@ let value: UpdateBYOKKeyRequest = {}; | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedApiKeyHashes` | *string*[] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` clears the restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | -| `allowedUserIds` | *string*[] | :heavy_minus_sign: | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | -| `declaredRegion` | [models.UpdateBYOKKeyRequestDeclaredRegion](../models/updatebyokkeyrequestdeclaredregion.mdx) | :heavy_minus_sign: | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Omit to leave the stored value unchanged (rotating an OpenAI or Fireworks `key` re-derives it from the new key); `null` clears the declaration. | null | -| `declaredZdr` | *boolean* | :heavy_minus_sign: | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Omit to leave the stored value unchanged; `null` clears the declaration. | null | -| `disabled` | *boolean* | :heavy_minus_sign: | Whether this credential is disabled. | false | -| `isByokOnly` | *boolean* | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Omit to leave the stored value unchanged. | false | -| `isFallback` | *boolean* | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. Omit to leave the stored value unchanged. | false | -| `isRequired` | *boolean* | :heavy_minus_sign: | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Omit to leave the stored value unchanged. | false | -| `key` | *string* | :heavy_minus_sign: | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | -| `name` | *string* | :heavy_minus_sign: | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file +| `allowedApiKeyHashes` | *string*[] | ➖ | Optional allowlist of OpenRouter API key hashes (`api_keys.hash`) that may use this credential. `null` clears the restriction. Must contain at least one hash if provided. Hashes that do not belong to your account return a 400. | [
"f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943"
] | +| `allowedModels` | *string*[] | ➖ | Optional allowlist of model slugs this credential may be used for. `null` means no restriction. | null | +| `allowedUserIds` | *string*[] | ➖ | Optional allowlist of user IDs that may use this credential. `null` means no restriction. | null | +| `declaredRegion` | [models.UpdateBYOKKeyRequestDeclaredRegion](../models/updatebyokkeyrequestdeclaredregion.mdx) | ➖ | Your declaration of the data region in which the upstream provider account behind this credential processes requests, used for routing eligibility on OpenRouter's regional hosts. `null` means undeclared and `global` is behaviorally identical: the credential follows the region OpenRouter records for the endpoint. `europe` or `us` lets requests to `eu.openrouter.ai` or `us.openrouter.ai` use this credential for that provider (private endpoints, endpoints pinned to another cloud region, cross-region inference profiles and video models are excluded). Self-declared and not verified by OpenRouter. For OpenAI and Fireworks the region comes from the key material (a `{"api_key": ..., "region": ...}` key), so the value must match the key's region. Among other providers, only Azure accepts `europe` or `us`. Omit to leave the stored value unchanged (rotating an OpenAI or Fireworks `key` re-derives it from the new key); `null` clears the declaration. | null | +| `declaredZdr` | *boolean* | ➖ | Your declaration of whether the upstream provider account behind this credential has zero data retention (ZDR). `null` inherits OpenRouter's data policy for the provider's endpoint; `true` declares the account ZDR so requests that require ZDR may route to this credential even when the shared endpoint retains data; `false` declares it non-ZDR so such requests never route to it. Self-declared and not verified by OpenRouter. Omit to leave the stored value unchanged; `null` clears the declaration. | null | +| `disabled` | *boolean* | ➖ | Whether this credential is disabled. | false | +| `isByokOnly` | *boolean* | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for every model, including models outside `allowed_models` and after all of your keys for the provider fail. The provider is skipped instead of spending OpenRouter credits. Only valid on non-fallback credentials. Omit to leave the stored value unchanged. | false | +| `isFallback` | *boolean* | ➖ | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. Cannot be combined with `is_byok_only`. Omit to leave the stored value unchanged. | false | +| `isRequired` | *boolean* | ➖ | Whether OpenRouter's shared endpoints on this provider are removed for the models this credential applies to (its `allowed_models`, or every model when `null`). Requests for those models run only on your keys; models outside the allowlist may still fall back to shared capacity on this provider. Omit to leave the stored value unchanged. | false | +| `key` | *string* | ➖ | A new raw provider API key to rotate the credential in-place. The previous key material is overwritten and the masked label is regenerated. Encrypted at rest and never returned in API responses. | sk-proj-newkey456... | +| `name` | *string* | ➖ | Optional human-readable name for the credential. | Updated OpenAI Key | \ No newline at end of file diff --git a/docs/models/updatebyokkeyresponse.mdx b/docs/models/updatebyokkeyresponse.mdx index f64cea097..22965fe07 100644 --- a/docs/models/updatebyokkeyresponse.mdx +++ b/docs/models/updatebyokkeyresponse.mdx @@ -32,4 +32,4 @@ let value: UpdateBYOKKeyResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.BYOKKey](../models/byokkey.mdx) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `data` | [models.BYOKKey](../models/byokkey.mdx) | ✅ | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"declared_region": null,
"declared_zdr": null,
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_byok_only": false,
"is_fallback": false,
"is_required": false,
"label": "sk-...AbCd",
"name": "Production OpenAI Key",
"provider": "openai",
"sort_order": 0,
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/updateenduserrequest.mdx b/docs/models/updateenduserrequest.mdx index d5e77b060..c9328c6e2 100644 --- a/docs/models/updateenduserrequest.mdx +++ b/docs/models/updateenduserrequest.mdx @@ -16,4 +16,4 @@ let value: UpdateEndUserRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `isActive` | *boolean* | :heavy_check_mark: | Registration state only; does not enforce inference access. | true | \ No newline at end of file +| `isActive` | *boolean* | ✅ | Registration state only; does not enforce inference access. | true | \ No newline at end of file diff --git a/docs/models/updateguardrailrequest.mdx b/docs/models/updateguardrailrequest.mdx index 500e672b7..83d76cf0a 100644 --- a/docs/models/updateguardrailrequest.mdx +++ b/docs/models/updateguardrailrequest.mdx @@ -14,24 +14,24 @@ let value: UpdateGuardrailRequest = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDataRegions` | [models.GuardrailDataRegion](../models/guardraildataregion.mdx)[] | :heavy_minus_sign: | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | -| `allowedModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | -| `allowedProviders` | *string*[] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](../models/contentfilterbuiltinentryinput.mdx)[] | :heavy_minus_sign: | Builtin content filters to apply. Set to null to remove. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | -| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry.mdx)[] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | -| `description` | *string* | :heavy_minus_sign: | New description for the guardrail | Updated description | -| `enableFreeModelPublication` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | -| `enableFreeModelTraining` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | -| `enablePaidModelTraining` | *boolean* | :heavy_minus_sign: | Whether this guardrail allows paid endpoints that train on request data. | true | -| ~~`enforceZdr`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | -| `enforceZdrAnthropic` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | -| `enforceZdrGoogle` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | -| `enforceZdrOpenai` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | -| `enforceZdrOther` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | true | -| `enforceZdrXai` | *boolean* | :heavy_minus_sign: | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | -| `ignoredModels` | *string*[] | :heavy_minus_sign: | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | -| `ignoredProviders` | *string*[] | :heavy_minus_sign: | List of provider IDs to exclude from routing | [
"azure"
] | -| `includeByokInBudgets` | *boolean* | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Omit to leave unchanged. | true | -| `limitUsd` | *number* | :heavy_minus_sign: | New spending limit in USD | 75 | -| `name` | *string* | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval.mdx) | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file +| `allowedDataRegions` | [models.GuardrailDataRegion](../models/guardraildataregion.mdx)[] | ➖ | Data regions through which requests governed by this guardrail must arrive. `global` is https://openrouter.ai, `europe` is https://eu.openrouter.ai, and `us` is https://us.openrouter.ai. Requests arriving through any other region are rejected. `null` leaves the ingress region unrestricted. When several guardrails apply (workspace default, member, API key), the effective regions are the intersection of every non-null value. An empty array is rejected. | [
"europe"
] | +| `allowedModels` | *string*[] | ➖ | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | +| `allowedProviders` | *string*[] | ➖ | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | +| `contentFilterBuiltins` | [models.ContentFilterBuiltinEntryInput](../models/contentfilterbuiltinentryinput.mdx)[] | ➖ | Builtin content filters to apply. Set to null to remove. Every builtin slug supports "block", "redact", and the detect-only "flag" action. | [
\{
"action": "block",
"slug": "regex-prompt-injection"
}
] | +| `contentFilters` | [models.ContentFilterEntry](../models/contentfilterentry.mdx)[] | ➖ | Custom regex content filters to apply. Set to null to remove. | null | +| `description` | *string* | ➖ | New description for the guardrail | Updated description | +| `enableFreeModelPublication` | *boolean* | ➖ | Whether this guardrail allows free endpoints that publish prompts. | false | +| `enableFreeModelTraining` | *boolean* | ➖ | Whether this guardrail allows free endpoints that train on request data. | true | +| `enablePaidModelTraining` | *boolean* | ➖ | Whether this guardrail allows paid endpoints that train on request data. | true | +| ~~`enforceZdr`~~ | *boolean* | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. Use enforce_zdr_anthropic, enforce_zdr_openai, enforce_zdr_google, enforce_zdr_xai, and enforce_zdr_other instead. When provided, its value is copied into any of those per-provider fields that are not explicitly specified on the request. | true | +| `enforceZdrAnthropic` | *boolean* | ➖ | Whether to enforce zero data retention for Anthropic models. Falls back to enforce_zdr when not provided. | true | +| `enforceZdrGoogle` | *boolean* | ➖ | Whether to enforce zero data retention for Google models. Falls back to enforce_zdr when not provided. | true | +| `enforceZdrOpenai` | *boolean* | ➖ | Whether to enforce zero data retention for OpenAI models. Falls back to enforce_zdr when not provided. | true | +| `enforceZdrOther` | *boolean* | ➖ | Whether to enforce zero data retention for models that are not from Anthropic, OpenAI, Google, or xAI. Falls back to enforce_zdr when not provided. | true | +| `enforceZdrXai` | *boolean* | ➖ | Whether to enforce zero data retention for xAI models. Falls back to enforce_zdr when not provided. | true | +| `ignoredModels` | *string*[] | ➖ | Array of model identifiers to exclude from routing (slug or canonical_slug accepted) | [
"openai/gpt-4o-mini"
] | +| `ignoredProviders` | *string*[] | ➖ | List of provider IDs to exclude from routing | [
"azure"
] | +| `includeByokInBudgets` | *boolean* | ➖ | Whether BYOK (bring-your-own-key) inference spend counts toward this guardrail's limit_usd, in addition to OpenRouter credit spend. Omit to leave unchanged. | true | +| `limitUsd` | *number* | ➖ | New spending limit in USD | 75 | +| `name` | *string* | ➖ | New name for the guardrail | Updated Guardrail Name | +| `resetInterval` | [models.GuardrailInterval](../models/guardrailinterval.mdx) | ➖ | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file diff --git a/docs/models/updateguardrailresponse.mdx b/docs/models/updateguardrailresponse.mdx index eb7d52022..2fd7622ba 100644 --- a/docs/models/updateguardrailresponse.mdx +++ b/docs/models/updateguardrailresponse.mdx @@ -22,4 +22,4 @@ let value: UpdateGuardrailResponse = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Guardrail](../models/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file +| `data` | [models.Guardrail](../models/guardrail.mdx) | ✅ | N/A | \{
"allowed_data_regions": null,
"allowed_models": null,
"allowed_providers": [
"openai",
"anthropic",
"google"
],
"content_filter_builtins": [
\{
"action": "redact",
"label": "[EMAIL]",
"slug": "email"
}
],
"content_filters": null,
"created_at": "2025-08-24T10:30:00Z",
"description": "Guardrail for production environment",
"enable_free_model_publication": false,
"enable_free_model_training": true,
"enable_paid_model_training": true,
"enforce_zdr": null,
"enforce_zdr_anthropic": true,
"enforce_zdr_google": false,
"enforce_zdr_openai": true,
"enforce_zdr_other": false,
"enforce_zdr_xai": false,
"id": "550e8400-e29b-41d4-a716-446655440000",
"ignored_models": null,
"ignored_providers": null,
"include_byok_in_budgets": false,
"limit_usd": 100,
"name": "Production Guardrail",
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "0df9e665-d932-5740-b2c7-b52af166bc11"
} | \ No newline at end of file diff --git a/docs/models/updateinternrequest.mdx b/docs/models/updateinternrequest.mdx index 01c720876..9c4ca333e 100644 --- a/docs/models/updateinternrequest.mdx +++ b/docs/models/updateinternrequest.mdx @@ -16,7 +16,7 @@ let value: UpdateInternRequest = {}; | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `description` | *string* | :heavy_minus_sign: | New free-form description. Null clears it. | -| `instructions` | *string* | :heavy_minus_sign: | New standing instructions. Null clears them. | -| `model` | *string* | :heavy_minus_sign: | New OpenRouter model slug in `author/slug` form (an optional `:variant` suffix is accepted). Other shapes are refused with 400. Null restores the workspace default. Takes effect on the next provision: until then `GET` shows this configured model while chat chunks show the model the running intern reports. | -| `name` | *string* | :heavy_minus_sign: | New intern name, unique per creator within the workspace. | \ No newline at end of file +| `description` | *string* | ➖ | New free-form description. Null clears it. | +| `instructions` | *string* | ➖ | New standing instructions. Null clears them. | +| `model` | *string* | ➖ | New OpenRouter model slug in `author/slug` form (an optional `:variant` suffix is accepted). Other shapes are refused with 400. Null restores the workspace default. Takes effect on the next provision: until then `GET` shows this configured model while chat chunks show the model the running intern reports. | +| `name` | *string* | ➖ | New intern name, unique per creator within the workspace. | \ No newline at end of file diff --git a/docs/models/updateobservabilitydestinationrequest.mdx b/docs/models/updateobservabilitydestinationrequest.mdx index 5f1b1cce2..13edfe52e 100644 --- a/docs/models/updateobservabilitydestinationrequest.mdx +++ b/docs/models/updateobservabilitydestinationrequest.mdx @@ -14,14 +14,14 @@ let value: UpdateObservabilityDestinationRequest = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apiKeyHashes` | *string*[] | :heavy_minus_sign: | Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided. | null | -| `broadcastGenerationCost` | *boolean* | :heavy_minus_sign: | Whether to include cost and billing generation metadata. | false | -| `broadcastGenerationIdentity` | *boolean* | :heavy_minus_sign: | Whether to include identity generation metadata. | false | -| `broadcastGenerationRequestContext` | *boolean* | :heavy_minus_sign: | Whether to include request-context generation metadata. | false | -| `config` | Record\ | :heavy_minus_sign: | Provider-specific configuration fields to update. Masked values are ignored; unset fields keep their current value. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | -| `enabled` | *boolean* | :heavy_minus_sign: | Whether the destination is enabled. | true | -| `filterRules` | [models.ObservabilityFilterRulesConfigNullable](../models/observabilityfilterrulesconfignullable.mdx) | :heavy_minus_sign: | N/A | null | -| `name` | *string* | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | -| `privacyMode` | *boolean* | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | -| `regions` | [models.ObservabilityDataRegionInput](../models/observabilitydataregioninput.mdx)[] | :heavy_minus_sign: | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field keeps the current value; it cannot be cleared. | [
"global"
] | -| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file +| `apiKeyHashes` | *string*[] | ➖ | Optional allowlist of OpenRouter API key hashes. `null` clears the filter (all keys). Omitting leaves the current value. Must contain at least one hash if provided. | null | +| `broadcastGenerationCost` | *boolean* | ➖ | Whether to include cost and billing generation metadata. | false | +| `broadcastGenerationIdentity` | *boolean* | ➖ | Whether to include identity generation metadata. | false | +| `broadcastGenerationRequestContext` | *boolean* | ➖ | Whether to include request-context generation metadata. | false | +| `config` | Record\ | ➖ | Provider-specific configuration fields to update. Masked values are ignored; unset fields keep their current value. | \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
} | +| `enabled` | *boolean* | ➖ | Whether the destination is enabled. | true | +| `filterRules` | [models.ObservabilityFilterRulesConfigNullable](../models/observabilityfilterrulesconfignullable.mdx) | ➖ | N/A | null | +| `name` | *string* | ➖ | Human-readable name for the destination. | Production Langfuse | +| `privacyMode` | *boolean* | ➖ | When true, request/response bodies are not forwarded — only metadata. | false | +| `regions` | [models.ObservabilityDataRegionInput](../models/observabilitydataregioninput.mdx)[] | ➖ | Data regions this destination applies to. `eu` is accepted as an alias for `europe` and normalizes to `europe`. Omitting this field keeps the current value; it cannot be cleared. | [
"global"
] | +| `samplingRate` | *number* | ➖ | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file diff --git a/docs/models/updateobservabilitydestinationresponse.mdx b/docs/models/updateobservabilitydestinationresponse.mdx index 6cde229bb..bfb06e2c5 100644 --- a/docs/models/updateobservabilitydestinationresponse.mdx +++ b/docs/models/updateobservabilitydestinationresponse.mdx @@ -39,4 +39,4 @@ let value: UpdateObservabilityDestinationResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | *models.ObservabilityDestination* | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `data` | *models.ObservabilityDestination* | ✅ | N/A | \{
"api_key_hashes": null,
"broadcast_generation_cost": false,
"broadcast_generation_identity": false,
"broadcast_generation_request_context": false,
"config": \{
"baseUrl": "https://us.cloud.langfuse.com",
"publicKey": "pk-l...EfGh",
"secretKey": "sk-l...AbCd"
},
"created_at": "2025-08-24T10:30:00Z",
"enabled": true,
"filter_rules": null,
"id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
"name": "Production Langfuse",
"privacy_mode": false,
"regions": [
"global"
],
"sampling_rate": 1,
"type": "langfuse",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/updateorganizationsettingsrequest.mdx b/docs/models/updateorganizationsettingsrequest.mdx index cc281bc92..703a92f84 100644 --- a/docs/models/updateorganizationsettingsrequest.mdx +++ b/docs/models/updateorganizationsettingsrequest.mdx @@ -16,4 +16,4 @@ let value: UpdateOrganizationSettingsRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `isFilteredModelCatalogEnabled` | *boolean* | :heavy_check_mark: | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file +| `isFilteredModelCatalogEnabled` | *boolean* | ✅ | When true, `GET /api/v1/models` called with one of the organization's API keys returns only the models that key can use (the `/api/v1/models/user` catalog), and the signed-in dashboard shows the same list. Anonymous requests always receive the public catalog. | true | \ No newline at end of file diff --git a/docs/models/updateprivateendpointpricingrequest.mdx b/docs/models/updateprivateendpointpricingrequest.mdx index e69b06305..160207504 100644 --- a/docs/models/updateprivateendpointpricingrequest.mdx +++ b/docs/models/updateprivateendpointpricingrequest.mdx @@ -19,4 +19,4 @@ let value: UpdatePrivateEndpointPricingRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `pricing` | [models.PrivateEndpointPricing](../models/privateendpointpricing.mdx) | :heavy_check_mark: | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | \ No newline at end of file +| `pricing` | [models.PrivateEndpointPricing](../models/privateendpointpricing.mdx) | ✅ | Negotiated per-token rates reported for requests routed to this endpoint. | \{
"completion": "0.00001",
"prompt": "0.0000025"
} | \ No newline at end of file diff --git a/docs/models/updateprivateendpointrequest.mdx b/docs/models/updateprivateendpointrequest.mdx index 81d0896f7..d0392c001 100644 --- a/docs/models/updateprivateendpointrequest.mdx +++ b/docs/models/updateprivateendpointrequest.mdx @@ -16,7 +16,7 @@ let value: UpdatePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `baseUrl` | *string* | :heavy_minus_sign: | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | -| `declaredRegion` | [models.UpdatePrivateEndpointRequestDeclaredRegion](../models/updateprivateendpointrequestdeclaredregion.mdx) | :heavy_minus_sign: | Attest where this deployment processes data. | us | -| `declaredZdr` | *boolean* | :heavy_minus_sign: | Attest that this deployment retains no prompt or completion data. | | -| `upstreamModelId` | *string* | :heavy_check_mark: | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file +| `baseUrl` | *string* | ➖ | HTTPS base URL of your deployment. Required unless the provider derives its URL from the BYOK credential (Azure, Amazon Bedrock, Google Vertex). | https://contoso.openai.azure.com | +| `declaredRegion` | [models.UpdatePrivateEndpointRequestDeclaredRegion](../models/updateprivateendpointrequestdeclaredregion.mdx) | ➖ | Attest where this deployment processes data. | us | +| `declaredZdr` | *boolean* | ➖ | Attest that this deployment retains no prompt or completion data. | | +| `upstreamModelId` | *string* | ✅ | Model or deployment identifier sent to the upstream provider. | gpt-4o-prod | \ No newline at end of file diff --git a/docs/models/updatescimgroupmappingrequest.mdx b/docs/models/updatescimgroupmappingrequest.mdx index 95e957e93..3acd7d8d0 100644 --- a/docs/models/updatescimgroupmappingrequest.mdx +++ b/docs/models/updatescimgroupmappingrequest.mdx @@ -16,4 +16,4 @@ let value: UpdateScimGroupMappingRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `role` | [models.UpdateScimGroupMappingRequestRole](../models/updatescimgroupmappingrequestrole.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `role` | [models.UpdateScimGroupMappingRequestRole](../models/updatescimgroupmappingrequestrole.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/updatescimgroupmappingresponse.mdx b/docs/models/updatescimgroupmappingresponse.mdx index c1bd39dfd..1dc349e80 100644 --- a/docs/models/updatescimgroupmappingresponse.mdx +++ b/docs/models/updatescimgroupmappingresponse.mdx @@ -24,4 +24,4 @@ let value: UpdateScimGroupMappingResponse = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.ScimGroupMapping](../models/scimgroupmapping.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file +| `data` | [models.ScimGroupMapping](../models/scimgroupmapping.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00.000Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"organization_id": "org_123456",
"role": "member",
"scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
"updated_at": "2025-08-24T10:30:00.000Z",
"workspace_id": "660e8400-e29b-41d4-a716-446655440000"
} | \ No newline at end of file diff --git a/docs/models/updateworkspacerequest.mdx b/docs/models/updateworkspacerequest.mdx index 432624af4..f3aa4f7bd 100644 --- a/docs/models/updateworkspacerequest.mdx +++ b/docs/models/updateworkspacerequest.mdx @@ -14,15 +14,15 @@ let value: UpdateWorkspaceRequest = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `defaultImageModel` | *string* | :heavy_minus_sign: | Default image model for this workspace | openai/dall-e-3 | -| `defaultProviderSort` | *string* | :heavy_minus_sign: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `defaultTextModel` | *string* | :heavy_minus_sign: | Default text model for this workspace | openai/gpt-4o | -| `description` | *string* | :heavy_minus_sign: | New description for the workspace | Updated description | -| `disabledServerTools` | [models.UpdateWorkspaceRequestDisabledServerTool](../models/updateworkspacerequestdisabledservertool.mdx)[] | :heavy_minus_sign: | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | -| `ioLoggingApiKeyIds` | *number*[] | :heavy_minus_sign: | Optional array of API key IDs to filter I/O logging | null | -| `ioLoggingSamplingRate` | *number* | :heavy_minus_sign: | Sampling rate for I/O logging (0.0001-1) | 1 | -| `isDataDiscountLoggingEnabled` | *boolean* | :heavy_minus_sign: | Whether data discount logging is enabled | true | -| `isObservabilityBroadcastEnabled` | *boolean* | :heavy_minus_sign: | Whether broadcast is enabled | false | -| `isObservabilityIoLoggingEnabled` | *boolean* | :heavy_minus_sign: | Whether private logging is enabled | false | -| `name` | *string* | :heavy_minus_sign: | New name for the workspace | Updated Workspace | -| `slug` | *string* | :heavy_minus_sign: | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file +| `defaultImageModel` | *string* | ➖ | Default image model for this workspace | openai/dall-e-3 | +| `defaultProviderSort` | *string* | ➖ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `defaultTextModel` | *string* | ➖ | Default text model for this workspace | openai/gpt-4o | +| `description` | *string* | ➖ | New description for the workspace | Updated description | +| `disabledServerTools` | [models.UpdateWorkspaceRequestDisabledServerTool](../models/updateworkspacerequestdisabledservertool.mdx)[] | ➖ | OpenRouter server tools that requests in this workspace may not invoke. Requests naming a disabled tool are rejected with 403. An empty array or null clears the list. | [
"openrouter:web_search",
"openrouter:bash"
] | +| `ioLoggingApiKeyIds` | *number*[] | ➖ | Optional array of API key IDs to filter I/O logging | null | +| `ioLoggingSamplingRate` | *number* | ➖ | Sampling rate for I/O logging (0.0001-1) | 1 | +| `isDataDiscountLoggingEnabled` | *boolean* | ➖ | Whether data discount logging is enabled | true | +| `isObservabilityBroadcastEnabled` | *boolean* | ➖ | Whether broadcast is enabled | false | +| `isObservabilityIoLoggingEnabled` | *boolean* | ➖ | Whether private logging is enabled | false | +| `name` | *string* | ➖ | New name for the workspace | Updated Workspace | +| `slug` | *string* | ➖ | New URL-friendly slug (lowercase alphanumeric segments separated by single hyphens, no leading/trailing hyphens) | updated-workspace | \ No newline at end of file diff --git a/docs/models/updateworkspaceresponse.mdx b/docs/models/updateworkspaceresponse.mdx index 01fbc39b0..6249cd442 100644 --- a/docs/models/updateworkspaceresponse.mdx +++ b/docs/models/updateworkspaceresponse.mdx @@ -33,4 +33,4 @@ let value: UpdateWorkspaceResponse = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.Workspace](../models/workspace.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file +| `data` | [models.Workspace](../models/workspace.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"created_by": "user_abc123",
"default_guardrail_id": "595d5849-7e86-51fd-a7c0-705c34e4afff",
"default_image_model": "openai/dall-e-3",
"default_provider_sort": "price",
"default_text_model": "openai/gpt-4o",
"description": "Production environment workspace",
"disabled_server_tools": null,
"id": "550e8400-e29b-41d4-a716-446655440000",
"include_byok_in_budgets": false,
"io_logging_api_key_ids": null,
"io_logging_sampling_rate": 1,
"is_data_discount_logging_enabled": true,
"is_observability_broadcast_enabled": false,
"is_observability_io_logging_enabled": false,
"name": "Production",
"slug": "production",
"updated_at": "2025-08-24T15:45:00Z"
} | \ No newline at end of file diff --git a/docs/models/upscalefactor.mdx b/docs/models/upscalefactor.mdx index a0b8e89d7..0f81053f3 100644 --- a/docs/models/upscalefactor.mdx +++ b/docs/models/upscalefactor.mdx @@ -16,5 +16,5 @@ let value: UpscaleFactor = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `max` | *number* | :heavy_minus_sign: | N/A | -| `min` | *number* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `max` | *number* | ➖ | N/A | +| `min` | *number* | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/upsertworkspacebudgetrequest.mdx b/docs/models/upsertworkspacebudgetrequest.mdx index 0d9c669bb..d02a6dfb1 100644 --- a/docs/models/upsertworkspacebudgetrequest.mdx +++ b/docs/models/upsertworkspacebudgetrequest.mdx @@ -16,5 +16,5 @@ let value: UpsertWorkspaceBudgetRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `includeByokInBudgets` | *boolean* | :heavy_minus_sign: | Whether to include BYOK (bring-your-own-key) spend when enforcing the workspace's budgets. This is a workspace-wide setting: it applies to every budget interval (daily, weekly, monthly, and lifetime), not just the interval being upserted in this request. Omit to leave the current setting unchanged. | true | -| `limitUsd` | *number* | :heavy_check_mark: | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file +| `includeByokInBudgets` | *boolean* | ➖ | Whether to include BYOK (bring-your-own-key) spend when enforcing the workspace's budgets. This is a workspace-wide setting: it applies to every budget interval (daily, weekly, monthly, and lifetime), not just the interval being upserted in this request. Omit to leave the current setting unchanged. | true | +| `limitUsd` | *number* | ✅ | Spending limit in USD. Must be greater than 0. | 100 | \ No newline at end of file diff --git a/docs/models/upsertworkspacebudgetresponse.mdx b/docs/models/upsertworkspacebudgetresponse.mdx index 05e4329cb..1a2ed835a 100644 --- a/docs/models/upsertworkspacebudgetresponse.mdx +++ b/docs/models/upsertworkspacebudgetresponse.mdx @@ -23,5 +23,5 @@ let value: UpsertWorkspaceBudgetResponse = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.WorkspaceBudget](../models/workspacebudget.mdx) | :heavy_check_mark: | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | -| `includeByokInBudgets` | *boolean* | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file +| `data` | [models.WorkspaceBudget](../models/workspacebudget.mdx) | ✅ | N/A | \{
"created_at": "2025-08-24T10:30:00Z",
"id": "770e8400-e29b-41d4-a716-446655440000",
"limit_usd": 100,
"reset_interval": "monthly",
"updated_at": "2025-08-24T15:45:00Z",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000"
} | +| `includeByokInBudgets` | *boolean* | ➖ | Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime). | true | \ No newline at end of file diff --git a/docs/models/upstream.mdx b/docs/models/upstream.mdx index 630daad07..680cda4bc 100644 --- a/docs/models/upstream.mdx +++ b/docs/models/upstream.mdx @@ -19,5 +19,5 @@ let value: Upstream = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `provider` | *string* | :heavy_check_mark: | The provider name stored on the batch. | OpenAI | -| `status` | [models.BatchDeletionOutcome](../models/batchdeletionoutcome.mdx) | :heavy_check_mark: | Outcome for one deletion target: `deleted` (removed), `unsupported` (the provider has no batch-delete API; supported file cleanup still runs), or `not_applicable` (the batch never reached that target). | deleted | \ No newline at end of file +| `provider` | *string* | ✅ | The provider name stored on the batch. | OpenAI | +| `status` | [models.BatchDeletionOutcome](../models/batchdeletionoutcome.mdx) | ✅ | Outcome for one deletion target: `deleted` (removed), `unsupported` (the provider has no batch-delete API; supported file cleanup still runs), or `not_applicable` (the batch never reached that target). | deleted | \ No newline at end of file diff --git a/docs/models/urlcitation.mdx b/docs/models/urlcitation.mdx index 4d19d9623..6e1c25fd0 100644 --- a/docs/models/urlcitation.mdx +++ b/docs/models/urlcitation.mdx @@ -20,9 +20,9 @@ let value: URLCitation = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `content` | *string* | :heavy_minus_sign: | N/A | -| `endIndex` | *number* | :heavy_check_mark: | N/A | -| `startIndex` | *number* | :heavy_check_mark: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `type` | *"url_citation"* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `content` | *string* | ➖ | N/A | +| `endIndex` | *number* | ✅ | N/A | +| `startIndex` | *number* | ✅ | N/A | +| `title` | *string* | ✅ | N/A | +| `type` | *"url_citation"* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/usage.mdx b/docs/models/usage.mdx index 9eb96b1b5..81a04f4be 100644 --- a/docs/models/usage.mdx +++ b/docs/models/usage.mdx @@ -24,12 +24,12 @@ let value: Usage = { | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `inputTokens` | *number* | :heavy_check_mark: | N/A | | -| `inputTokensDetails` | [models.InputTokensDetails](../models/inputtokensdetails.mdx) | :heavy_check_mark: | N/A | | -| `outputTokens` | *number* | :heavy_check_mark: | N/A | | -| `outputTokensDetails` | [models.OutputTokensDetails](../models/outputtokensdetails.mdx) | :heavy_check_mark: | N/A | | -| `totalTokens` | *number* | :heavy_check_mark: | N/A | | -| `cost` | *number* | :heavy_minus_sign: | Cost of the completion | | -| `costDetails` | [models.UsageCostDetails](../models/usagecostdetails.mdx) | :heavy_minus_sign: | N/A | | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `serverToolUseDetails` | [models.ServerToolUseDetails](../models/servertoolusedetails.mdx) | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | \ No newline at end of file +| `inputTokens` | *number* | ✅ | N/A | | +| `inputTokensDetails` | [models.InputTokensDetails](../models/inputtokensdetails.mdx) | ✅ | N/A | | +| `outputTokens` | *number* | ✅ | N/A | | +| `outputTokensDetails` | [models.OutputTokensDetails](../models/outputtokensdetails.mdx) | ✅ | N/A | | +| `totalTokens` | *number* | ✅ | N/A | | +| `cost` | *number* | ➖ | Cost of the completion | | +| `costDetails` | [models.UsageCostDetails](../models/usagecostdetails.mdx) | ➖ | N/A | | +| `isByok` | *boolean* | ➖ | Whether a request was made using a Bring Your Own Key configuration | | +| `serverToolUseDetails` | [models.ServerToolUseDetails](../models/servertoolusedetails.mdx) | ➖ | Usage for server-side tool execution (e.g., web search) | \{
"tool_calls_executed": 2,
"tool_calls_requested": 2,
"web_search_requests": 2
} | \ No newline at end of file diff --git a/docs/models/usagecostdetails.mdx b/docs/models/usagecostdetails.mdx index 5bc20da5c..bebc65cd1 100644 --- a/docs/models/usagecostdetails.mdx +++ b/docs/models/usagecostdetails.mdx @@ -17,7 +17,7 @@ let value: UsageCostDetails = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `serverToolCost` | *number* | :heavy_minus_sign: | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | -| `upstreamInferenceCost` | *number* | :heavy_minus_sign: | N/A | -| `upstreamInferenceInputCost` | *number* | :heavy_check_mark: | N/A | -| `upstreamInferenceOutputCost` | *number* | :heavy_check_mark: | N/A | \ No newline at end of file +| `serverToolCost` | *number* | ➖ | Metered server-tool execution cost (for example, shell sandbox time) billed for this request, in USD. Matches the billed checkpoint and settlement amounts exactly. 0 when a metered server tool ran but settled at zero dollars; absent when no metered server tool ran. | +| `upstreamInferenceCost` | *number* | ➖ | N/A | +| `upstreamInferenceInputCost` | *number* | ✅ | N/A | +| `upstreamInferenceOutputCost` | *number* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/userlocation.mdx b/docs/models/userlocation.mdx index a7fb9f4d0..8ef3a0886 100644 --- a/docs/models/userlocation.mdx +++ b/docs/models/userlocation.mdx @@ -18,8 +18,8 @@ let value: UserLocation = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.WebSearchPluginType](../models/websearchplugintype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `city` | *string* | ➖ | N/A | +| `country` | *string* | ➖ | N/A | +| `region` | *string* | ➖ | N/A | +| `timezone` | *string* | ➖ | N/A | +| `type` | [models.WebSearchPluginType](../models/websearchplugintype.mdx) | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/validateprivateendpointrequest.mdx b/docs/models/validateprivateendpointrequest.mdx index a452a13a3..a4bb24fe7 100644 --- a/docs/models/validateprivateendpointrequest.mdx +++ b/docs/models/validateprivateendpointrequest.mdx @@ -16,4 +16,4 @@ let value: ValidatePrivateEndpointRequest = { | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `workspaceId` | *string* | :heavy_check_mark: | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `workspaceId` | *string* | ✅ | Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/vaulteffectivesecret.mdx b/docs/models/vaulteffectivesecret.mdx index 4430f3457..47081d07f 100644 --- a/docs/models/vaulteffectivesecret.mdx +++ b/docs/models/vaulteffectivesecret.mdx @@ -25,8 +25,8 @@ let value: VaultEffectiveSecret = { | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `fingerprint` | *string* | :heavy_check_mark: | N/A | -| `hosts` | *string*[] | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | -| `scope` | [models.VaultEffectiveSecretScope](../models/vaulteffectivesecretscope.mdx) | :heavy_check_mark: | Where the delivered secret is stored: `intern` for the intern's own vault, `attached` for a vault attached to the intern, `workspace` for the workspace vault. | \ No newline at end of file +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | N/A | +| `fingerprint` | *string* | ✅ | N/A | +| `hosts` | *string*[] | ✅ | N/A | +| `name` | *string* | ✅ | N/A | +| `scope` | [models.VaultEffectiveSecretScope](../models/vaulteffectivesecretscope.mdx) | ✅ | Where the delivered secret is stored: `intern` for the intern's own vault, `attached` for a vault attached to the intern, `workspace` for the workspace vault. | \ No newline at end of file diff --git a/docs/models/vaulteffectivesecretlistresponse.mdx b/docs/models/vaulteffectivesecretlistresponse.mdx index afade5fcf..6130a98f9 100644 --- a/docs/models/vaulteffectivesecretlistresponse.mdx +++ b/docs/models/vaulteffectivesecretlistresponse.mdx @@ -47,5 +47,5 @@ let value: VaultEffectiveSecretListResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.VaultEffectiveSecret](../models/vaulteffectivesecret.mdx)[] | :heavy_check_mark: | N/A | -| `hasMore` | *boolean* | :heavy_check_mark: | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file +| `data` | [models.VaultEffectiveSecret](../models/vaulteffectivesecret.mdx)[] | ✅ | N/A | +| `hasMore` | *boolean* | ✅ | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file diff --git a/docs/models/vaultsecret.mdx b/docs/models/vaultsecret.mdx index e14dae23f..eda66db6c 100644 --- a/docs/models/vaultsecret.mdx +++ b/docs/models/vaultsecret.mdx @@ -24,7 +24,7 @@ let value: VaultSecret = { | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | -| `fingerprint` | *string* | :heavy_check_mark: | N/A | -| `hosts` | *string*[] | :heavy_check_mark: | N/A | -| `name` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | ✅ | N/A | +| `fingerprint` | *string* | ✅ | N/A | +| `hosts` | *string*[] | ✅ | N/A | +| `name` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/vaultsecretcopyrequest.mdx b/docs/models/vaultsecretcopyrequest.mdx index be50d8f1d..1dcd46a20 100644 --- a/docs/models/vaultsecretcopyrequest.mdx +++ b/docs/models/vaultsecretcopyrequest.mdx @@ -20,4 +20,4 @@ let value: VaultSecretCopyRequest = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `names` | *string*[] | :heavy_check_mark: | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | \ No newline at end of file +| `names` | *string*[] | ✅ | Names of workspace secrets to copy, 1 to 100 unique entries. Every name must exist in the workspace scope. | \ No newline at end of file diff --git a/docs/models/vaultsecretcopyresponse.mdx b/docs/models/vaultsecretcopyresponse.mdx index 0cdcf527a..d2f8b71f0 100644 --- a/docs/models/vaultsecretcopyresponse.mdx +++ b/docs/models/vaultsecretcopyresponse.mdx @@ -28,4 +28,4 @@ let value: VaultSecretCopyResponse = { | Field | Type | Required | Description | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | -| `data` | [models.VaultSecret](../models/vaultsecret.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.VaultSecret](../models/vaultsecret.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/vaultsecretlistresponse.mdx b/docs/models/vaultsecretlistresponse.mdx index cb50845a1..f6c880441 100644 --- a/docs/models/vaultsecretlistresponse.mdx +++ b/docs/models/vaultsecretlistresponse.mdx @@ -35,5 +35,5 @@ let value: VaultSecretListResponse = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.VaultSecret](../models/vaultsecret.mdx)[] | :heavy_check_mark: | N/A | -| `hasMore` | *boolean* | :heavy_check_mark: | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file +| `data` | [models.VaultSecret](../models/vaultsecret.mdx)[] | ✅ | N/A | +| `hasMore` | *boolean* | ✅ | True when more secrets exist beyond this page. Request the next page with `offset` increased by the number of returned entries. | \ No newline at end of file diff --git a/docs/models/vaultsecretresponse.mdx b/docs/models/vaultsecretresponse.mdx index a4c78fd34..569f9d3a5 100644 --- a/docs/models/vaultsecretresponse.mdx +++ b/docs/models/vaultsecretresponse.mdx @@ -26,4 +26,4 @@ let value: VaultSecretResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `data` | [models.VaultSecret](../models/vaultsecret.mdx) | :heavy_check_mark: | Metadata for one stored secret. The secret value is never returned. `fingerprint` is an HMAC-SHA-256 of the value keyed with that vault's own data key, so it is comparable only within one vault: equal fingerprints in one vault mean equal values, and rewriting the same value keeps its fingerprint. The same value stored in two vaults (for example a workspace secret and its intern copy) carries different fingerprints, so comparing fingerprints across vaults cannot show that a copy matches or that a rotation propagated. `hosts` and `fingerprint` are `null` only for legacy rows written before host binding was required; storing the secret again assigns hosts. | \{
"created_at": "2026-09-15T17:44:00.000Z",
"fingerprint": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"hosts": [
"api.github.com"
],
"name": "github_token"
} | \ No newline at end of file +| `data` | [models.VaultSecret](../models/vaultsecret.mdx) | ✅ | Metadata for one stored secret. The secret value is never returned. `fingerprint` is an HMAC-SHA-256 of the value keyed with that vault's own data key, so it is comparable only within one vault: equal fingerprints in one vault mean equal values, and rewriting the same value keeps its fingerprint. The same value stored in two vaults (for example a workspace secret and its intern copy) carries different fingerprints, so comparing fingerprints across vaults cannot show that a copy matches or that a rotation propagated. `hosts` and `fingerprint` are `null` only for legacy rows written before host binding was required; storing the secret again assigns hosts. | \{
"created_at": "2026-09-15T17:44:00.000Z",
"fingerprint": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"hosts": [
"api.github.com"
],
"name": "github_token"
} | \ No newline at end of file diff --git a/docs/models/vaultsecretwriterequest.mdx b/docs/models/vaultsecretwriterequest.mdx index 84de20024..674022dab 100644 --- a/docs/models/vaultsecretwriterequest.mdx +++ b/docs/models/vaultsecretwriterequest.mdx @@ -21,5 +21,5 @@ let value: VaultSecretWriteRequest = { | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `hosts` | *string*[] | :heavy_check_mark: | Exact DNS hostnames the secret may be sent to, 1 to 100 entries. Each entry is lowercased and a trailing dot is removed, so `API.Example.com.` is stored as `api.example.com`. Schemes, ports, paths, wildcards and empty values are rejected. Duplicates after normalization are collapsed. Matching is exact: a secret bound to `api.example.com` is never released to `example.com` or any other hostname. | -| `value` | *string* | :heavy_check_mark: | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | \ No newline at end of file +| `hosts` | *string*[] | ✅ | Exact DNS hostnames the secret may be sent to, 1 to 100 entries. Each entry is lowercased and a trailing dot is removed, so `API.Example.com.` is stored as `api.example.com`. Schemes, ports, paths, wildcards and empty values are rejected. Duplicates after normalization are collapsed. Matching is exact: a secret bound to `api.example.com` is never released to `example.com` or any other hostname. | +| `value` | *string* | ✅ | Secret value, 1 to 65536 characters. It is encrypted at rest and never returned. | \ No newline at end of file diff --git a/docs/models/videogeneration.mdx b/docs/models/videogeneration.mdx index dba8453b0..5cf27940b 100644 --- a/docs/models/videogeneration.mdx +++ b/docs/models/videogeneration.mdx @@ -28,6 +28,6 @@ let value: VideoGeneration = { | Field | Type | Required | Description | Example | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | -| `requestCount` | *number* | :heavy_check_mark: | Total requests admitted for this workload in the window. | | -| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file +| `latency` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `requestCount` | *number* | ✅ | Total requests admitted for this workload in the window. | | +| `throughput` | [models.PercentileStats](../models/percentilestats.mdx) | ✅ | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | \ No newline at end of file diff --git a/docs/models/videogenerationrequest.mdx b/docs/models/videogenerationrequest.mdx index b43d5fb31..928cc8057 100644 --- a/docs/models/videogenerationrequest.mdx +++ b/docs/models/videogenerationrequest.mdx @@ -16,21 +16,21 @@ let value: VideoGenerationRequest = { | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aspectRatio` | [models.VideoGenerationRequestAspectRatio](../models/videogenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | -| `callbackUrl` | *string* | :heavy_minus_sign: | URL to receive a webhook notification when the video generation job completes. Overrides the workspace-level default callback URL if set. Must be HTTPS. | https://example.com/webhook | -| `creativity` | *number* | :heavy_minus_sign: | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | -| `duration` | *number* | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | -| `frameImages` | [models.FrameImage](../models/frameimage.mdx)[] | :heavy_minus_sign: | Images to use as the first and/or last frame of the generated video. Each image must specify a frame_type of first_frame or last_frame. | | -| `generateAudio` | *boolean* | :heavy_minus_sign: | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | -| `inputReferences` | *models.InputReference*[] | :heavy_minus_sign: | Reference assets to guide video generation. Accepts image, audio, and video references. Audio and video references are only honored by providers that support them (including BytePlus Seedance generation 2 and newer); other providers use image references and ignore the rest. | | -| `model` | *string* | :heavy_check_mark: | N/A | | -| `previousJobId` | *string* | :heavy_minus_sign: | ID of a completed video job to edit or extend, as returned by the submit response. The new job runs on the same model and endpoint that produced the previous one. Only models that support continuation accept this field. | gen-vid-1789493115-a1B2c3D4e5F6g7H8i9J0 | -| `prompt` | *string* | :heavy_minus_sign: | Text prompt describing the video to generate. Optional for models that support generating a video from image input alone; required by all other models. | A serene mountain landscape at sunset | -| `provider` | [models.VideoGenerationRequestProvider](../models/videogenerationrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `resolution` | [models.VideoGenerationRequestResolution](../models/videogenerationrequestresolution.mdx) | :heavy_minus_sign: | Resolution of the generated video | 720p | -| `seed` | *number* | :heavy_minus_sign: | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | -| `sessionId` | *string* | :heavy_minus_sign: | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | -| `size` | *string* | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | -| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | :heavy_minus_sign: | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | -| `upscaleFactor` | *number* | :heavy_minus_sign: | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | -| `user` | *string* | :heavy_minus_sign: | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file +| `aspectRatio` | [models.VideoGenerationRequestAspectRatio](../models/videogenerationrequestaspectratio.mdx) | ➖ | Aspect ratio of the generated video | 16:9 | +| `callbackUrl` | *string* | ➖ | URL to receive a webhook notification when the video generation job completes. Overrides the workspace-level default callback URL if set. Must be HTTPS. | https://example.com/webhook | +| `creativity` | *number* | ➖ | Creativity level for video upscaling models only. This parameter is not supported by video generation models. | 1 | +| `duration` | *number* | ➖ | Duration of the generated video in seconds | 8 | +| `frameImages` | [models.FrameImage](../models/frameimage.mdx)[] | ➖ | Images to use as the first and/or last frame of the generated video. Each image must specify a frame_type of first_frame or last_frame. | | +| `generateAudio` | *boolean* | ➖ | Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set. | true | +| `inputReferences` | *models.InputReference*[] | ➖ | Reference assets to guide video generation. Accepts image, audio, and video references. Audio and video references are only honored by providers that support them (including BytePlus Seedance generation 2 and newer); other providers use image references and ignore the rest. | | +| `model` | *string* | ✅ | N/A | | +| `previousJobId` | *string* | ➖ | ID of a completed video job to edit or extend, as returned by the submit response. The new job runs on the same model and endpoint that produced the previous one. Only models that support continuation accept this field. | gen-vid-1789493115-a1B2c3D4e5F6g7H8i9J0 | +| `prompt` | *string* | ➖ | Text prompt describing the video to generate. Optional for models that support generating a video from image input alone; required by all other models. | A serene mountain landscape at sunset | +| `provider` | [models.VideoGenerationRequestProvider](../models/videogenerationrequestprovider.mdx) | ➖ | Provider-specific passthrough configuration | | +| `resolution` | [models.VideoGenerationRequestResolution](../models/videogenerationrequestresolution.mdx) | ➖ | Resolution of the generated video | 720p | +| `seed` | *number* | ➖ | If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers. | | +| `sessionId` | *string* | ➖ | A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters. | session-1234 | +| `size` | *string* | ➖ | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | +| `trace` | [models.TraceConfig](../models/traceconfig.mdx) | ➖ | Metadata for observability and tracing. Known keys (trace_id, trace_name, span_name, generation_name, parent_span_id) have special handling. Additional keys are passed through as custom metadata to configured broadcast destinations. | \{
"trace_id": "trace-abc123",
"trace_name": "my-app-trace"
} | +| `upscaleFactor` | *number* | ➖ | Upscale factor for video upscaling models only. This parameter is not supported by video generation models. | 2 | +| `user` | *string* | ➖ | A unique identifier representing your end-user. Forwarded to Broadcast and private logging as the end-user id; never sent to the provider. | user-1234 | \ No newline at end of file diff --git a/docs/models/videogenerationrequestoptions.mdx b/docs/models/videogenerationrequestoptions.mdx index dfed3202d..d9251285d 100644 --- a/docs/models/videogenerationrequestoptions.mdx +++ b/docs/models/videogenerationrequestoptions.mdx @@ -16,149 +16,149 @@ let value: VideoGenerationRequestOptions = {}; | Field | Type | Required | Description | | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `oneai` | Record\ | :heavy_minus_sign: | N/A | -| `ai21` | Record\ | :heavy_minus_sign: | N/A | -| `aionLabs` | Record\ | :heavy_minus_sign: | N/A | -| `akashml` | Record\ | :heavy_minus_sign: | N/A | -| `alibaba` | Record\ | :heavy_minus_sign: | N/A | -| `amazonBedrock` | Record\ | :heavy_minus_sign: | N/A | -| `amazonBedrockClaudeOnAws` | Record\ | :heavy_minus_sign: | N/A | -| `amazonNova` | Record\ | :heavy_minus_sign: | N/A | -| `ambient` | Record\ | :heavy_minus_sign: | N/A | -| `anthropic` | Record\ | :heavy_minus_sign: | N/A | -| `anthropic2` | Record\ | :heavy_minus_sign: | N/A | -| `anyscale` | Record\ | :heavy_minus_sign: | N/A | -| `arceeAi` | Record\ | :heavy_minus_sign: | N/A | -| `assemblyai` | Record\ | :heavy_minus_sign: | N/A | -| `atlasCloud` | Record\ | :heavy_minus_sign: | N/A | -| `atoma` | Record\ | :heavy_minus_sign: | N/A | -| `avian` | Record\ | :heavy_minus_sign: | N/A | -| `azure` | Record\ | :heavy_minus_sign: | N/A | -| `baidu` | Record\ | :heavy_minus_sign: | N/A | -| `baseten` | Record\ | :heavy_minus_sign: | N/A | -| `blackForestLabs` | Record\ | :heavy_minus_sign: | N/A | -| `byteplus` | Record\ | :heavy_minus_sign: | N/A | -| `centml` | Record\ | :heavy_minus_sign: | N/A | -| `cerebras` | Record\ | :heavy_minus_sign: | N/A | -| `chutes` | Record\ | :heavy_minus_sign: | N/A | -| `cirrascale` | Record\ | :heavy_minus_sign: | N/A | -| `clarifai` | Record\ | :heavy_minus_sign: | N/A | -| `claudeOnAws` | Record\ | :heavy_minus_sign: | N/A | -| `cloudflare` | Record\ | :heavy_minus_sign: | N/A | -| `cohere` | Record\ | :heavy_minus_sign: | N/A | -| `coreweave` | Record\ | :heavy_minus_sign: | N/A | -| `cosine` | Record\ | :heavy_minus_sign: | N/A | -| `crofai` | Record\ | :heavy_minus_sign: | N/A | -| `crucible` | Record\ | :heavy_minus_sign: | N/A | -| `crusoe` | Record\ | :heavy_minus_sign: | N/A | -| `darkbloom` | Record\ | :heavy_minus_sign: | N/A | -| `databricks` | Record\ | :heavy_minus_sign: | N/A | -| `decart` | Record\ | :heavy_minus_sign: | N/A | -| `deepgram` | Record\ | :heavy_minus_sign: | N/A | -| `deepinfra` | Record\ | :heavy_minus_sign: | N/A | -| `deepseek` | Record\ | :heavy_minus_sign: | N/A | -| `dekallm` | Record\ | :heavy_minus_sign: | N/A | -| `digitalocean` | Record\ | :heavy_minus_sign: | N/A | -| `elevenlabs` | Record\ | :heavy_minus_sign: | N/A | -| `enfer` | Record\ | :heavy_minus_sign: | N/A | -| `fakeProvider` | Record\ | :heavy_minus_sign: | N/A | -| `featherless` | Record\ | :heavy_minus_sign: | N/A | -| `fireworks` | Record\ | :heavy_minus_sign: | N/A | -| `fishAudio` | Record\ | :heavy_minus_sign: | N/A | -| `friendli` | Record\ | :heavy_minus_sign: | N/A | -| `gmicloud` | Record\ | :heavy_minus_sign: | N/A | -| `googleAiStudio` | Record\ | :heavy_minus_sign: | N/A | -| `googleVertex` | Record\ | :heavy_minus_sign: | N/A | -| `gopomelo` | Record\ | :heavy_minus_sign: | N/A | -| `groq` | Record\ | :heavy_minus_sign: | N/A | -| `heygen` | Record\ | :heavy_minus_sign: | N/A | -| `huggingface` | Record\ | :heavy_minus_sign: | N/A | -| `hyperbolic` | Record\ | :heavy_minus_sign: | N/A | -| `hyperbolicQuantized` | Record\ | :heavy_minus_sign: | N/A | -| `inception` | Record\ | :heavy_minus_sign: | N/A | -| `inceptron` | Record\ | :heavy_minus_sign: | N/A | -| `inferactVllm` | Record\ | :heavy_minus_sign: | N/A | -| `inferenceNet` | Record\ | :heavy_minus_sign: | N/A | -| `infermatic` | Record\ | :heavy_minus_sign: | N/A | -| `inflection` | Record\ | :heavy_minus_sign: | N/A | -| `inocloud` | Record\ | :heavy_minus_sign: | N/A | -| `ioNet` | Record\ | :heavy_minus_sign: | N/A | -| `ionstream` | Record\ | :heavy_minus_sign: | N/A | -| `klusterai` | Record\ | :heavy_minus_sign: | N/A | -| `krea` | Record\ | :heavy_minus_sign: | N/A | -| `lambda` | Record\ | :heavy_minus_sign: | N/A | -| `lepton` | Record\ | :heavy_minus_sign: | N/A | -| `liquid` | Record\ | :heavy_minus_sign: | N/A | -| `lynn` | Record\ | :heavy_minus_sign: | N/A | -| `lynnPrivate` | Record\ | :heavy_minus_sign: | N/A | -| `makora` | Record\ | :heavy_minus_sign: | N/A | -| `mancer` | Record\ | :heavy_minus_sign: | N/A | -| `mancerOld` | Record\ | :heavy_minus_sign: | N/A | -| `mara` | Record\ | :heavy_minus_sign: | N/A | -| `meta` | Record\ | :heavy_minus_sign: | N/A | -| `minimax` | Record\ | :heavy_minus_sign: | N/A | -| `mistral` | Record\ | :heavy_minus_sign: | N/A | -| `modal` | Record\ | :heavy_minus_sign: | N/A | -| `modelrun` | Record\ | :heavy_minus_sign: | N/A | -| `modular` | Record\ | :heavy_minus_sign: | N/A | -| `moonshotai` | Record\ | :heavy_minus_sign: | N/A | -| `morph` | Record\ | :heavy_minus_sign: | N/A | -| `ncompass` | Record\ | :heavy_minus_sign: | N/A | -| `nearAi` | Record\ | :heavy_minus_sign: | N/A | -| `nebius` | Record\ | :heavy_minus_sign: | N/A | -| `nexAgi` | Record\ | :heavy_minus_sign: | N/A | -| `nextbit` | Record\ | :heavy_minus_sign: | N/A | -| `nineteen` | Record\ | :heavy_minus_sign: | N/A | -| `novita` | Record\ | :heavy_minus_sign: | N/A | -| `nvidia` | Record\ | :heavy_minus_sign: | N/A | -| `octoai` | Record\ | :heavy_minus_sign: | N/A | -| `ollama` | Record\ | :heavy_minus_sign: | N/A | -| `openInference` | Record\ | :heavy_minus_sign: | N/A | -| `openai` | Record\ | :heavy_minus_sign: | N/A | -| `parasail` | Record\ | :heavy_minus_sign: | N/A | -| `perceptron` | Record\ | :heavy_minus_sign: | N/A | -| `perplexity` | Record\ | :heavy_minus_sign: | N/A | -| `phala` | Record\ | :heavy_minus_sign: | N/A | -| `poolside` | Record\ | :heavy_minus_sign: | N/A | -| `primeintellect` | Record\ | :heavy_minus_sign: | N/A | -| `quiver` | Record\ | :heavy_minus_sign: | N/A | -| `recraft` | Record\ | :heavy_minus_sign: | N/A | -| `recursal` | Record\ | :heavy_minus_sign: | N/A | -| `reflection` | Record\ | :heavy_minus_sign: | N/A | -| `reka` | Record\ | :heavy_minus_sign: | N/A | -| `relace` | Record\ | :heavy_minus_sign: | N/A | -| `replicate` | Record\ | :heavy_minus_sign: | N/A | -| `respan` | Record\ | :heavy_minus_sign: | N/A | -| `runway` | Record\ | :heavy_minus_sign: | N/A | -| `sailResearch` | Record\ | :heavy_minus_sign: | N/A | -| `sakana` | Record\ | :heavy_minus_sign: | N/A | -| `sakanaAi` | Record\ | :heavy_minus_sign: | N/A | -| `sambanova` | Record\ | :heavy_minus_sign: | N/A | -| `sambanovaCloaked` | Record\ | :heavy_minus_sign: | N/A | -| `scaledown` | Record\ | :heavy_minus_sign: | N/A | -| `seed` | Record\ | :heavy_minus_sign: | N/A | -| `sfCompute` | Record\ | :heavy_minus_sign: | N/A | -| `siliconflow` | Record\ | :heavy_minus_sign: | N/A | -| `sourceful` | Record\ | :heavy_minus_sign: | N/A | -| `stealth` | Record\ | :heavy_minus_sign: | N/A | -| `stepfun` | Record\ | :heavy_minus_sign: | N/A | -| `streamlake` | Record\ | :heavy_minus_sign: | N/A | -| `switchpoint` | Record\ | :heavy_minus_sign: | N/A | -| `targon` | Record\ | :heavy_minus_sign: | N/A | -| `tencent` | Record\ | :heavy_minus_sign: | N/A | -| `tenstorrent` | Record\ | :heavy_minus_sign: | N/A | -| `thinkingmachines` | Record\ | :heavy_minus_sign: | N/A | -| `together` | Record\ | :heavy_minus_sign: | N/A | -| `togetherLite` | Record\ | :heavy_minus_sign: | N/A | -| `typesafe` | Record\ | :heavy_minus_sign: | N/A | -| `ubicloud` | Record\ | :heavy_minus_sign: | N/A | -| `unbiased` | Record\ | :heavy_minus_sign: | N/A | -| `upstage` | Record\ | :heavy_minus_sign: | N/A | -| `venice` | Record\ | :heavy_minus_sign: | N/A | -| `voyageai` | Record\ | :heavy_minus_sign: | N/A | -| `wafer` | Record\ | :heavy_minus_sign: | N/A | -| `wandb` | Record\ | :heavy_minus_sign: | N/A | -| `wandbLegacy` | Record\ | :heavy_minus_sign: | N/A | -| `xai` | Record\ | :heavy_minus_sign: | N/A | -| `xiaomi` | Record\ | :heavy_minus_sign: | N/A | -| `zAi` | Record\ | :heavy_minus_sign: | N/A | \ No newline at end of file +| `oneai` | Record\ | ➖ | N/A | +| `ai21` | Record\ | ➖ | N/A | +| `aionLabs` | Record\ | ➖ | N/A | +| `akashml` | Record\ | ➖ | N/A | +| `alibaba` | Record\ | ➖ | N/A | +| `amazonBedrock` | Record\ | ➖ | N/A | +| `amazonBedrockClaudeOnAws` | Record\ | ➖ | N/A | +| `amazonNova` | Record\ | ➖ | N/A | +| `ambient` | Record\ | ➖ | N/A | +| `anthropic` | Record\ | ➖ | N/A | +| `anthropic2` | Record\ | ➖ | N/A | +| `anyscale` | Record\ | ➖ | N/A | +| `arceeAi` | Record\ | ➖ | N/A | +| `assemblyai` | Record\ | ➖ | N/A | +| `atlasCloud` | Record\ | ➖ | N/A | +| `atoma` | Record\ | ➖ | N/A | +| `avian` | Record\ | ➖ | N/A | +| `azure` | Record\ | ➖ | N/A | +| `baidu` | Record\ | ➖ | N/A | +| `baseten` | Record\ | ➖ | N/A | +| `blackForestLabs` | Record\ | ➖ | N/A | +| `byteplus` | Record\ | ➖ | N/A | +| `centml` | Record\ | ➖ | N/A | +| `cerebras` | Record\ | ➖ | N/A | +| `chutes` | Record\ | ➖ | N/A | +| `cirrascale` | Record\ | ➖ | N/A | +| `clarifai` | Record\ | ➖ | N/A | +| `claudeOnAws` | Record\ | ➖ | N/A | +| `cloudflare` | Record\ | ➖ | N/A | +| `cohere` | Record\ | ➖ | N/A | +| `coreweave` | Record\ | ➖ | N/A | +| `cosine` | Record\ | ➖ | N/A | +| `crofai` | Record\ | ➖ | N/A | +| `crucible` | Record\ | ➖ | N/A | +| `crusoe` | Record\ | ➖ | N/A | +| `darkbloom` | Record\ | ➖ | N/A | +| `databricks` | Record\ | ➖ | N/A | +| `decart` | Record\ | ➖ | N/A | +| `deepgram` | Record\ | ➖ | N/A | +| `deepinfra` | Record\ | ➖ | N/A | +| `deepseek` | Record\ | ➖ | N/A | +| `dekallm` | Record\ | ➖ | N/A | +| `digitalocean` | Record\ | ➖ | N/A | +| `elevenlabs` | Record\ | ➖ | N/A | +| `enfer` | Record\ | ➖ | N/A | +| `fakeProvider` | Record\ | ➖ | N/A | +| `featherless` | Record\ | ➖ | N/A | +| `fireworks` | Record\ | ➖ | N/A | +| `fishAudio` | Record\ | ➖ | N/A | +| `friendli` | Record\ | ➖ | N/A | +| `gmicloud` | Record\ | ➖ | N/A | +| `googleAiStudio` | Record\ | ➖ | N/A | +| `googleVertex` | Record\ | ➖ | N/A | +| `gopomelo` | Record\ | ➖ | N/A | +| `groq` | Record\ | ➖ | N/A | +| `heygen` | Record\ | ➖ | N/A | +| `huggingface` | Record\ | ➖ | N/A | +| `hyperbolic` | Record\ | ➖ | N/A | +| `hyperbolicQuantized` | Record\ | ➖ | N/A | +| `inception` | Record\ | ➖ | N/A | +| `inceptron` | Record\ | ➖ | N/A | +| `inferactVllm` | Record\ | ➖ | N/A | +| `inferenceNet` | Record\ | ➖ | N/A | +| `infermatic` | Record\ | ➖ | N/A | +| `inflection` | Record\ | ➖ | N/A | +| `inocloud` | Record\ | ➖ | N/A | +| `ioNet` | Record\ | ➖ | N/A | +| `ionstream` | Record\ | ➖ | N/A | +| `klusterai` | Record\ | ➖ | N/A | +| `krea` | Record\ | ➖ | N/A | +| `lambda` | Record\ | ➖ | N/A | +| `lepton` | Record\ | ➖ | N/A | +| `liquid` | Record\ | ➖ | N/A | +| `lynn` | Record\ | ➖ | N/A | +| `lynnPrivate` | Record\ | ➖ | N/A | +| `makora` | Record\ | ➖ | N/A | +| `mancer` | Record\ | ➖ | N/A | +| `mancerOld` | Record\ | ➖ | N/A | +| `mara` | Record\ | ➖ | N/A | +| `meta` | Record\ | ➖ | N/A | +| `minimax` | Record\ | ➖ | N/A | +| `mistral` | Record\ | ➖ | N/A | +| `modal` | Record\ | ➖ | N/A | +| `modelrun` | Record\ | ➖ | N/A | +| `modular` | Record\ | ➖ | N/A | +| `moonshotai` | Record\ | ➖ | N/A | +| `morph` | Record\ | ➖ | N/A | +| `ncompass` | Record\ | ➖ | N/A | +| `nearAi` | Record\ | ➖ | N/A | +| `nebius` | Record\ | ➖ | N/A | +| `nexAgi` | Record\ | ➖ | N/A | +| `nextbit` | Record\ | ➖ | N/A | +| `nineteen` | Record\ | ➖ | N/A | +| `novita` | Record\ | ➖ | N/A | +| `nvidia` | Record\ | ➖ | N/A | +| `octoai` | Record\ | ➖ | N/A | +| `ollama` | Record\ | ➖ | N/A | +| `openInference` | Record\ | ➖ | N/A | +| `openai` | Record\ | ➖ | N/A | +| `parasail` | Record\ | ➖ | N/A | +| `perceptron` | Record\ | ➖ | N/A | +| `perplexity` | Record\ | ➖ | N/A | +| `phala` | Record\ | ➖ | N/A | +| `poolside` | Record\ | ➖ | N/A | +| `primeintellect` | Record\ | ➖ | N/A | +| `quiver` | Record\ | ➖ | N/A | +| `recraft` | Record\ | ➖ | N/A | +| `recursal` | Record\ | ➖ | N/A | +| `reflection` | Record\ | ➖ | N/A | +| `reka` | Record\ | ➖ | N/A | +| `relace` | Record\ | ➖ | N/A | +| `replicate` | Record\ | ➖ | N/A | +| `respan` | Record\ | ➖ | N/A | +| `runway` | Record\ | ➖ | N/A | +| `sailResearch` | Record\ | ➖ | N/A | +| `sakana` | Record\ | ➖ | N/A | +| `sakanaAi` | Record\ | ➖ | N/A | +| `sambanova` | Record\ | ➖ | N/A | +| `sambanovaCloaked` | Record\ | ➖ | N/A | +| `scaledown` | Record\ | ➖ | N/A | +| `seed` | Record\ | ➖ | N/A | +| `sfCompute` | Record\ | ➖ | N/A | +| `siliconflow` | Record\ | ➖ | N/A | +| `sourceful` | Record\ | ➖ | N/A | +| `stealth` | Record\ | ➖ | N/A | +| `stepfun` | Record\ | ➖ | N/A | +| `streamlake` | Record\ | ➖ | N/A | +| `switchpoint` | Record\ | ➖ | N/A | +| `targon` | Record\ | ➖ | N/A | +| `tencent` | Record\ | ➖ | N/A | +| `tenstorrent` | Record\ | ➖ | N/A | +| `thinkingmachines` | Record\ | ➖ | N/A | +| `together` | Record\ | ➖ | N/A | +| `togetherLite` | Record\ | ➖ | N/A | +| `typesafe` | Record\ | ➖ | N/A | +| `ubicloud` | Record\ | ➖ | N/A | +| `unbiased` | Record\ | ➖ | N/A | +| `upstage` | Record\ | ➖ | N/A | +| `venice` | Record\ | ➖ | N/A | +| `voyageai` | Record\ | ➖ | N/A | +| `wafer` | Record\ | ➖ | N/A | +| `wandb` | Record\ | ➖ | N/A | +| `wandbLegacy` | Record\ | ➖ | N/A | +| `xai` | Record\ | ➖ | N/A | +| `xiaomi` | Record\ | ➖ | N/A | +| `zAi` | Record\ | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/videogenerationrequestprovider.mdx b/docs/models/videogenerationrequestprovider.mdx index a016e25a7..3e14c4366 100644 --- a/docs/models/videogenerationrequestprovider.mdx +++ b/docs/models/videogenerationrequestprovider.mdx @@ -16,4 +16,4 @@ let value: VideoGenerationRequestProvider = {}; | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `options` | [models.VideoGenerationRequestOptions](../models/videogenerationrequestoptions.mdx) | :heavy_minus_sign: | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file +| `options` | [models.VideoGenerationRequestOptions](../models/videogenerationrequestoptions.mdx) | ➖ | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file diff --git a/docs/models/videogenerationresponse.mdx b/docs/models/videogenerationresponse.mdx index a6fa07799..8061824a8 100644 --- a/docs/models/videogenerationresponse.mdx +++ b/docs/models/videogenerationresponse.mdx @@ -18,10 +18,10 @@ let value: VideoGenerationResponse = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `error` | *string* | :heavy_minus_sign: | N/A | | -| `generationId` | *string* | :heavy_minus_sign: | The generation ID associated with this video generation job. Available once the job has been processed. | | -| `id` | *string* | :heavy_check_mark: | The video job ID, in the `gen-vid--<20 alphanumerics>` generation ID format. Pass it as `previous_job_id` to continue the generation. | | -| `pollingUrl` | *string* | :heavy_check_mark: | N/A | | -| `status` | [models.VideoGenerationResponseStatus](../models/videogenerationresponsestatus.mdx) | :heavy_check_mark: | N/A | | -| `unsignedUrls` | *string*[] | :heavy_minus_sign: | N/A | | -| `usage` | [models.VideoGenerationUsage](../models/videogenerationusage.mdx) | :heavy_minus_sign: | Usage and cost information for the video generation. Available once the job has completed. | \{
"cost": 0.5,
"is_byok": false
} | \ No newline at end of file +| `error` | *string* | ➖ | N/A | | +| `generationId` | *string* | ➖ | The generation ID associated with this video generation job. Available once the job has been processed. | | +| `id` | *string* | ✅ | The video job ID, in the `gen-vid--<20 alphanumerics>` generation ID format. Pass it as `previous_job_id` to continue the generation. | | +| `pollingUrl` | *string* | ✅ | N/A | | +| `status` | [models.VideoGenerationResponseStatus](../models/videogenerationresponsestatus.mdx) | ✅ | N/A | | +| `unsignedUrls` | *string*[] | ➖ | N/A | | +| `usage` | [models.VideoGenerationUsage](../models/videogenerationusage.mdx) | ➖ | Usage and cost information for the video generation. Available once the job has completed. | \{
"cost": 0.5,
"is_byok": false
} | \ No newline at end of file diff --git a/docs/models/videogenerationusage.mdx b/docs/models/videogenerationusage.mdx index d18f50883..9e05d7a8a 100644 --- a/docs/models/videogenerationusage.mdx +++ b/docs/models/videogenerationusage.mdx @@ -16,5 +16,5 @@ let value: VideoGenerationUsage = {}; | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `cost` | *number* | :heavy_minus_sign: | The cost of the video generation in USD. | -| `isByok` | *boolean* | :heavy_minus_sign: | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file +| `cost` | *number* | ➖ | The cost of the video generation in USD. | +| `isByok` | *boolean* | ➖ | Whether the request was made using a Bring Your Own Key configuration. | \ No newline at end of file diff --git a/docs/models/videomodel.mdx b/docs/models/videomodel.mdx index d7517af18..30a00874e 100644 --- a/docs/models/videomodel.mdx +++ b/docs/models/videomodel.mdx @@ -39,20 +39,20 @@ let value: VideoModel = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `allowedPassthroughParameters` | *string*[] | :heavy_check_mark: | List of parameters that are allowed to be passed through to the provider | | -| `canonicalSlug` | *string* | :heavy_check_mark: | Canonical slug for the model | openai/gpt-4 | -| `created` | *number* | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `creativity` | *number*[] | :heavy_check_mark: | Supported creativity levels for video upscaling models | | -| `description` | *string* | :heavy_minus_sign: | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | -| `generateAudio` | *boolean* | :heavy_check_mark: | Whether the model supports generating audio alongside video | | -| `huggingFaceId` | *string* | :heavy_minus_sign: | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the model | openai/gpt-4 | -| `name` | *string* | :heavy_check_mark: | Display name of the model | GPT-4 | -| `pricingSkus` | Record\ | :heavy_minus_sign: | Pricing SKUs with provider prefix stripped, values as strings | | -| `seed` | *boolean* | :heavy_check_mark: | Whether the model supports deterministic generation via seed parameter | | -| `supportedAspectRatios` | [models.SupportedAspectRatio](../models/supportedaspectratio.mdx)[] | :heavy_check_mark: | Supported output aspect ratios | | -| `supportedDurations` | *number*[] | :heavy_check_mark: | Supported video durations in seconds | | -| `supportedFrameImages` | [models.SupportedFrameImage](../models/supportedframeimage.mdx)[] | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | -| `supportedResolutions` | [models.SupportedResolution](../models/supportedresolution.mdx)[] | :heavy_check_mark: | Supported output resolutions | | -| `supportedSizes` | [models.SupportedSize](../models/supportedsize.mdx)[] | :heavy_check_mark: | Supported output sizes (width x height) | | -| `upscaleFactor` | [models.UpscaleFactor](../models/upscalefactor.mdx) | :heavy_check_mark: | Supported upscale factor range for video upscaling models | | \ No newline at end of file +| `allowedPassthroughParameters` | *string*[] | ✅ | List of parameters that are allowed to be passed through to the provider | | +| `canonicalSlug` | *string* | ✅ | Canonical slug for the model | openai/gpt-4 | +| `created` | *number* | ✅ | Unix timestamp of when the model was created | 1692901234 | +| `creativity` | *number*[] | ✅ | Supported creativity levels for video upscaling models | | +| `description` | *string* | ➖ | Description of the model | GPT-4 is a large multimodal model that can solve difficult problems with greater accuracy. | +| `generateAudio` | *boolean* | ✅ | Whether the model supports generating audio alongside video | | +| `huggingFaceId` | *string* | ➖ | Hugging Face model identifier, if applicable | microsoft/DialoGPT-medium | +| `id` | *string* | ✅ | Unique identifier for the model | openai/gpt-4 | +| `name` | *string* | ✅ | Display name of the model | GPT-4 | +| `pricingSkus` | Record\ | ➖ | Pricing SKUs with provider prefix stripped, values as strings | | +| `seed` | *boolean* | ✅ | Whether the model supports deterministic generation via seed parameter | | +| `supportedAspectRatios` | [models.SupportedAspectRatio](../models/supportedaspectratio.mdx)[] | ✅ | Supported output aspect ratios | | +| `supportedDurations` | *number*[] | ✅ | Supported video durations in seconds | | +| `supportedFrameImages` | [models.SupportedFrameImage](../models/supportedframeimage.mdx)[] | ✅ | Supported frame image types (e.g. first_frame, last_frame) | | +| `supportedResolutions` | [models.SupportedResolution](../models/supportedresolution.mdx)[] | ✅ | Supported output resolutions | | +| `supportedSizes` | [models.SupportedSize](../models/supportedsize.mdx)[] | ✅ | Supported output sizes (width x height) | | +| `upscaleFactor` | [models.UpscaleFactor](../models/upscalefactor.mdx) | ✅ | Supported upscale factor range for video upscaling models | | \ No newline at end of file diff --git a/docs/models/videomodelslistresponse.mdx b/docs/models/videomodelslistresponse.mdx index 956843506..084c6df3e 100644 --- a/docs/models/videomodelslistresponse.mdx +++ b/docs/models/videomodelslistresponse.mdx @@ -43,4 +43,4 @@ let value: VideoModelsListResponse = { | Field | Type | Required | Description | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | -| `data` | [models.VideoModel](../models/videomodel.mdx)[] | :heavy_check_mark: | N/A | \ No newline at end of file +| `data` | [models.VideoModel](../models/videomodel.mdx)[] | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/videourl.mdx b/docs/models/videourl.mdx index 4b1fb24af..7f4dccf37 100644 --- a/docs/models/videourl.mdx +++ b/docs/models/videourl.mdx @@ -16,4 +16,4 @@ let value: VideoUrl = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/webfetchplugin.mdx b/docs/models/webfetchplugin.mdx index 88eb23335..dbd281e07 100644 --- a/docs/models/webfetchplugin.mdx +++ b/docs/models/webfetchplugin.mdx @@ -16,8 +16,8 @@ let value: WebFetchPlugin = { | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Only fetch from these domains. | -| `blockedDomains` | *string*[] | :heavy_minus_sign: | Never fetch from these domains. | -| `id` | *"web-fetch"* | :heavy_check_mark: | N/A | -| `maxContentTokens` | *number* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file +| `allowedDomains` | *string*[] | ➖ | Only fetch from these domains. | +| `blockedDomains` | *string*[] | ➖ | Never fetch from these domains. | +| `id` | *"web-fetch"* | ✅ | N/A | +| `maxContentTokens` | *number* | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | +| `maxUses` | *number* | ➖ | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | \ No newline at end of file diff --git a/docs/models/webfetchservertool.mdx b/docs/models/webfetchservertool.mdx index 7d62758af..fa9de913f 100644 --- a/docs/models/webfetchservertool.mdx +++ b/docs/models/webfetchservertool.mdx @@ -18,5 +18,5 @@ let value: WebFetchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `parameters` | [models.WebFetchServerToolConfig](../models/webfetchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | -| `type` | [models.WebFetchServerToolType](../models/webfetchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.WebFetchServerToolConfig](../models/webfetchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | +| `type` | [models.WebFetchServerToolType](../models/webfetchservertooltype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/webfetchservertoolconfig.mdx b/docs/models/webfetchservertoolconfig.mdx index b833a602c..a59d8a3be 100644 --- a/docs/models/webfetchservertoolconfig.mdx +++ b/docs/models/webfetchservertoolconfig.mdx @@ -16,8 +16,8 @@ let value: WebFetchServerToolConfig = {}; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Only fetch from these domains. | | -| `blockedDomains` | *string*[] | :heavy_minus_sign: | Never fetch from these domains. | | -| `engine` | [models.WebFetchEngineEnum](../models/webfetchengineenum.mdx) | :heavy_minus_sign: | Which fetch engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in fetch. "exa" uses Exa Contents API. "openrouter" uses direct HTTP fetch. "firecrawl" uses Firecrawl scrape (requires BYOK). "parallel" uses the Parallel extract API. | auto | -| `maxContentTokens` | *number* | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file +| `allowedDomains` | *string*[] | ➖ | Only fetch from these domains. | | +| `blockedDomains` | *string*[] | ➖ | Never fetch from these domains. | | +| `engine` | [models.WebFetchEngineEnum](../models/webfetchengineenum.mdx) | ➖ | Which fetch engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in fetch. "exa" uses Exa Contents API. "openrouter" uses direct HTTP fetch. "firecrawl" uses Firecrawl scrape (requires BYOK). "parallel" uses the Parallel extract API. | auto | +| `maxContentTokens` | *number* | ➖ | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | +| `maxUses` | *number* | ➖ | Maximum number of web fetches per request. Once exceeded, the tool returns an error. | 10 | \ No newline at end of file diff --git a/docs/models/websearchcallcompletedevent.mdx b/docs/models/websearchcallcompletedevent.mdx index 4156e740c..5b47da089 100644 --- a/docs/models/websearchcallcompletedevent.mdx +++ b/docs/models/websearchcallcompletedevent.mdx @@ -21,7 +21,7 @@ let value: WebSearchCallCompletedEvent = { | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.web_search_call.completed"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.web_search_call.completed"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/websearchcallinprogressevent.mdx b/docs/models/websearchcallinprogressevent.mdx index 60ace6385..679cf33c7 100644 --- a/docs/models/websearchcallinprogressevent.mdx +++ b/docs/models/websearchcallinprogressevent.mdx @@ -21,7 +21,7 @@ let value: WebSearchCallInProgressEvent = { | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.web_search_call.in_progress"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.web_search_call.in_progress"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/websearchcallsearchingevent.mdx b/docs/models/websearchcallsearchingevent.mdx index feb69b626..de26debd2 100644 --- a/docs/models/websearchcallsearchingevent.mdx +++ b/docs/models/websearchcallsearchingevent.mdx @@ -21,7 +21,7 @@ let value: WebSearchCallSearchingEvent = { | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `itemId` | *string* | :heavy_check_mark: | N/A | -| `outputIndex` | *number* | :heavy_check_mark: | N/A | -| `sequenceNumber` | *number* | :heavy_check_mark: | N/A | -| `type` | *"response.web_search_call.searching"* | :heavy_check_mark: | N/A | \ No newline at end of file +| `itemId` | *string* | ✅ | N/A | +| `outputIndex` | *number* | ✅ | N/A | +| `sequenceNumber` | *number* | ✅ | N/A | +| `type` | *"response.web_search_call.searching"* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/websearchcitation.mdx b/docs/models/websearchcitation.mdx index 90a6c9d09..5981a6cfd 100644 --- a/docs/models/websearchcitation.mdx +++ b/docs/models/websearchcitation.mdx @@ -17,7 +17,7 @@ let value: WebSearchCitation = { | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `citedText` | *string* | :heavy_minus_sign: | N/A | -| `encryptedIndex` | *string* | :heavy_minus_sign: | N/A | -| `title` | *string* | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `citedText` | *string* | ➖ | N/A | +| `encryptedIndex` | *string* | ➖ | N/A | +| `title` | *string* | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/websearchconfig.mdx b/docs/models/websearchconfig.mdx index 06848c3ba..e17459ffa 100644 --- a/docs/models/websearchconfig.mdx +++ b/docs/models/websearchconfig.mdx @@ -14,14 +14,14 @@ let value: WebSearchConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | -| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `excludedDomains` | *string*[] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `maxCharacters` | *number* | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `maxTotalResults` | *number* | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `userLocation` | [models.WebSearchUserLocationServerTool](../models/websearchuserlocationservertool.mdx) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `allowedDomains` | *string*[] | ➖ | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `excludedDomains` | *string*[] | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `maxCharacters` | *number* | ➖ | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | +| `maxResults` | *number* | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `maxTotalResults` | *number* | ➖ | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | +| `maxUses` | *number* | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel.mdx) | ➖ | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `userLocation` | [models.WebSearchUserLocationServerTool](../models/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/websearchdomainfilter.mdx b/docs/models/websearchdomainfilter.mdx index 32c822ba3..ebcd36856 100644 --- a/docs/models/websearchdomainfilter.mdx +++ b/docs/models/websearchdomainfilter.mdx @@ -14,6 +14,6 @@ let value: WebSearchDomainFilter = {}; | Field | Type | Required | Description | | ------------------ | ------------------ | ------------------ | ------------------ | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | N/A | -| `blockedDomains` | *string*[] | :heavy_minus_sign: | N/A | -| `excludedDomains` | *string*[] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `allowedDomains` | *string*[] | ➖ | N/A | +| `blockedDomains` | *string*[] | ➖ | N/A | +| `excludedDomains` | *string*[] | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/websearchplugin.mdx b/docs/models/websearchplugin.mdx index 425d59a93..031f90c15 100644 --- a/docs/models/websearchplugin.mdx +++ b/docs/models/websearchplugin.mdx @@ -16,14 +16,14 @@ let value: WebSearchPlugin = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `enabled` | *boolean* | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | -| `engine` | [models.WebSearchEngine](../models/websearchengine.mdx) | :heavy_minus_sign: | The search engine to use for web search. | exa | -| `excludeDomains` | *string*[] | :heavy_minus_sign: | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | -| `id` | *"web"* | :heavy_check_mark: | N/A | | -| `includeDomains` | *string*[] | :heavy_minus_sign: | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | -| `maxResults` | *number* | :heavy_minus_sign: | N/A | | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic). | | -| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `searchPrompt` | *string* | :heavy_minus_sign: | N/A | | -| `userLocation` | [models.UserLocation](../models/userlocation.mdx) | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `enabled` | *boolean* | ➖ | Set to false to disable the web-search plugin for this request. Defaults to true. | | +| `engine` | [models.WebSearchEngine](../models/websearchengine.mdx) | ➖ | The search engine to use for web search. | exa | +| `excludeDomains` | *string*[] | ➖ | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | +| `id` | *"web"* | ✅ | N/A | | +| `includeDomains` | *string*[] | ➖ | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog"). | [
"example.com",
"*.substack.com",
"openai.com/blog"
] | +| `maxResults` | *number* | ➖ | N/A | | +| `maxUses` | *number* | ➖ | Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic). | | +| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `searchPrompt` | *string* | ➖ | N/A | | +| `userLocation` | [models.UserLocation](../models/userlocation.mdx) | ➖ | N/A | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/websearchservertool.mdx b/docs/models/websearchservertool.mdx index 1e70b3632..9661adb64 100644 --- a/docs/models/websearchservertool.mdx +++ b/docs/models/websearchservertool.mdx @@ -18,12 +18,12 @@ let value: WebSearchServerTool = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `filters` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `type` | [models.WebSearchServerToolType](../models/websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `userLocation` | [models.WebSearchUserLocation](../models/websearchuserlocation.mdx) | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `filters` | [models.WebSearchDomainFilter](../models/websearchdomainfilter.mdx) | ➖ | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `maxResults` | *number* | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `maxUses` | *number* | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `searchContextSize` | [models.SearchContextSizeEnum](../models/searchcontextsizeenum.mdx) | ➖ | Size of the search context for web search tools | medium | +| `type` | [models.WebSearchServerToolType](../models/websearchservertooltype.mdx) | ✅ | N/A | | +| `userLocation` | [models.WebSearchUserLocation](../models/websearchuserlocation.mdx) | ➖ | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/websearchservertoolconfig.mdx b/docs/models/websearchservertoolconfig.mdx index a8d2ec653..5c4530a57 100644 --- a/docs/models/websearchservertoolconfig.mdx +++ b/docs/models/websearchservertoolconfig.mdx @@ -16,14 +16,14 @@ let value: WebSearchServerToolConfig = {}; | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `allowedDomains` | *string*[] | :heavy_minus_sign: | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | -| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | :heavy_minus_sign: | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | -| `excludedDomains` | *string*[] | :heavy_minus_sign: | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | -| `maxCharacters` | *number* | :heavy_minus_sign: | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | -| `maxResults` | *number* | :heavy_minus_sign: | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | -| `maxTotalResults` | *number* | :heavy_minus_sign: | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | -| `maxUses` | *number* | :heavy_minus_sign: | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | -| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | :heavy_minus_sign: | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | -| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel.mdx) | :heavy_minus_sign: | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | -| `userLocation` | [models.WebSearchUserLocationServerTool](../models/websearchuserlocationservertool.mdx) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | -| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | :heavy_minus_sign: | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file +| `allowedDomains` | *string*[] | ➖ | Limit search results to these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, and most native providers (Anthropic, OpenAI, SpaceXAI). Cannot be used with excluded_domains. | | +| `engine` | [models.WebSearchEngineEnum](../models/websearchengineenum.mdx) | ➖ | Which search engine to use. "auto" (default) uses native if the provider supports it, otherwise Exa. "native" forces the provider's built-in search. "exa" forces the Exa search API. "firecrawl" uses Firecrawl (requires BYOK). "parallel" uses the Parallel search API. "perplexity" uses the Perplexity Search API (raw ranked results). | auto | +| `excludedDomains` | *string*[] | ➖ | Exclude search results from these domains. Supported by Exa, Firecrawl, Parallel, Perplexity, Anthropic, OpenAI, and SpaceXAI. Cannot be used with allowed_domains. | | +| `maxCharacters` | *number* | ➖ | Exact maximum number of characters of content per search result. Applies to the Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, caps highlight content per result. For Parallel, caps excerpt content per result (default 1,500 when omitted). For Perplexity, maps to the native `max_tokens_per_page` parameter (converted from characters to tokens) and trims the response to the exact character cap. When both `max_characters` and `search_context_size` are set, `max_characters` takes precedence. When omitted, falls back to `search_context_size` mapping (Exa) or engine defaults (Parallel, Perplexity). | 2000 | +| `maxResults` | *number* | ➖ | Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, Parallel, and Perplexity engines; ignored with native provider search. Perplexity supports a maximum of 20; values above 20 are clamped. | 5 | +| `maxTotalResults` | *number* | ➖ | Maximum total number of search results across all search calls in a single request. Once this limit is reached, the tool will stop returning new results. Useful for controlling cost and context size in agentic loops. Defaults to 50 when not specified. | 50 | +| `maxUses` | *number* | ➖ | Maximum number of web searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. Applies to the Exa, Firecrawl, Parallel, and Perplexity engines. With native provider search, forwarded only to Anthropic (as `max_uses`); other native search providers have no equivalent parameter and ignore it. | 3 | +| `mode` | [models.WebSearchMode](../models/websearchmode.mdx) | ➖ | Engine-native search mode. Exa supports instant, fast, auto (default), deep-lite, deep, and deep-reasoning. Parallel supports turbo, fast, basic (default), and advanced. Modes unsupported by the selected engine are ignored. | auto | +| `searchContextSize` | [models.SearchQualityLevel](../models/searchqualitylevel.mdx) | ➖ | How much context to retrieve per result. Applies to Exa, Parallel, and Perplexity engines; ignored with native provider search and Firecrawl. For Exa, pins a fixed per-result character cap (low=5,000, medium=15,000, high=30,000); when omitted, Exa picks an adaptive size per query and document (typically ~2,000–4,000 characters per result). For Parallel, controls the total characters across all results; when omitted, Parallel uses its own default size. For Perplexity, maps directly to the Search API's native search_context_size parameter. Overridden by `max_characters` when both are set. | medium | +| `userLocation` | [models.WebSearchUserLocationServerTool](../models/websearchuserlocationservertool.mdx) | ➖ | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | +| `xSearch` | [models.XSearchOptions](../models/xsearchoptions.mdx) | ➖ | Enable SpaceXAI X (Twitter) search alongside native web search, with optional filters. Only applies to SpaceXAI endpoints with native search; omit to search the web only. X search is billed separately by SpaceXAI, per post and per user profile fetched. | \{
"allowed_x_handles": [
"OpenRouterAI"
],
"from_date": "2025-01-01"
} | \ No newline at end of file diff --git a/docs/models/websearchservertoolopenrouter.mdx b/docs/models/websearchservertoolopenrouter.mdx index b991be011..5af7731d0 100644 --- a/docs/models/websearchservertoolopenrouter.mdx +++ b/docs/models/websearchservertoolopenrouter.mdx @@ -18,5 +18,5 @@ let value: WebSearchServerToolOpenRouter = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `parameters` | [models.WebSearchServerToolConfig](../models/websearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `type` | [models.WebSearchServerToolOpenRouterType](../models/websearchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `parameters` | [models.WebSearchServerToolConfig](../models/websearchservertoolconfig.mdx) | ➖ | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `type` | [models.WebSearchServerToolOpenRouterType](../models/websearchservertoolopenroutertype.mdx) | ✅ | N/A | | \ No newline at end of file diff --git a/docs/models/websearchsource.mdx b/docs/models/websearchsource.mdx index a59301bf3..205a66b95 100644 --- a/docs/models/websearchsource.mdx +++ b/docs/models/websearchsource.mdx @@ -17,5 +17,5 @@ let value: WebSearchSource = { | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `type` | [models.WebSearchSourceType](../models/websearchsourcetype.mdx) | :heavy_check_mark: | N/A | -| `url` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file +| `type` | [models.WebSearchSourceType](../models/websearchsourcetype.mdx) | ✅ | N/A | +| `url` | *string* | ✅ | N/A | \ No newline at end of file diff --git a/docs/models/websearchuserlocation.mdx b/docs/models/websearchuserlocation.mdx index 6f42bfa73..e9950dd08 100644 --- a/docs/models/websearchuserlocation.mdx +++ b/docs/models/websearchuserlocation.mdx @@ -16,8 +16,8 @@ let value: WebSearchUserLocation = {}; | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.WebSearchUserLocationType](../models/websearchuserlocationtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `city` | *string* | ➖ | N/A | +| `country` | *string* | ➖ | N/A | +| `region` | *string* | ➖ | N/A | +| `timezone` | *string* | ➖ | N/A | +| `type` | [models.WebSearchUserLocationType](../models/websearchuserlocationtype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/websearchuserlocationservertool.mdx b/docs/models/websearchuserlocationservertool.mdx index b0a75851b..0003fbc9b 100644 --- a/docs/models/websearchuserlocationservertool.mdx +++ b/docs/models/websearchuserlocationservertool.mdx @@ -16,8 +16,8 @@ let value: WebSearchUserLocationServerTool = {}; | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `city` | *string* | :heavy_minus_sign: | N/A | -| `country` | *string* | :heavy_minus_sign: | N/A | -| `region` | *string* | :heavy_minus_sign: | N/A | -| `timezone` | *string* | :heavy_minus_sign: | N/A | -| `type` | [models.WebSearchUserLocationServerToolType](../models/websearchuserlocationservertooltype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `city` | *string* | ➖ | N/A | +| `country` | *string* | ➖ | N/A | +| `region` | *string* | ➖ | N/A | +| `timezone` | *string* | ➖ | N/A | +| `type` | [models.WebSearchUserLocationServerToolType](../models/websearchuserlocationservertooltype.mdx) | ➖ | N/A | \ No newline at end of file diff --git a/docs/models/workspace.mdx b/docs/models/workspace.mdx index 2ec71593b..0021a77e4 100644 --- a/docs/models/workspace.mdx +++ b/docs/models/workspace.mdx @@ -31,21 +31,21 @@ let value: Workspace = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | -| `createdBy` | *string* | :heavy_check_mark: | User ID of the workspace creator | user_abc123 | -| `defaultGuardrailId` | *string* | :heavy_check_mark: | Deterministic ID derived from the workspace ID. The default guardrail is materialized when its configuration is first written. | 595d5849-7e86-51fd-a7c0-705c34e4afff | -| `defaultImageModel` | *string* | :heavy_check_mark: | Default image model for this workspace | openai/dall-e-3 | -| `defaultProviderSort` | *string* | :heavy_check_mark: | Default provider sort preference (price, throughput, latency, exacto) | price | -| `defaultTextModel` | *string* | :heavy_check_mark: | Default text model for this workspace | openai/gpt-4o | -| `description` | *string* | :heavy_check_mark: | Description of the workspace | Production environment workspace | -| `disabledServerTools` | *string*[] | :heavy_minus_sign: | OpenRouter server tools (e.g. openrouter:web_search) that requests in this workspace may not invoke. Null means no tools are disabled. | null | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | -| `includeByokInBudgets` | *boolean* | :heavy_minus_sign: | Whether BYOK (bring-your-own-key) spend counts toward this workspace's budgets. Set it via the workspace budget endpoints. | false | -| `ioLoggingApiKeyIds` | *number*[] | :heavy_check_mark: | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | -| `ioLoggingSamplingRate` | *number* | :heavy_check_mark: | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | -| `isDataDiscountLoggingEnabled` | *boolean* | :heavy_check_mark: | Whether data discount logging is enabled for this workspace | true | -| `isObservabilityBroadcastEnabled` | *boolean* | :heavy_check_mark: | Whether broadcast is enabled for this workspace | false | -| `isObservabilityIoLoggingEnabled` | *boolean* | :heavy_check_mark: | Whether private logging is enabled for this workspace | false | -| `name` | *string* | :heavy_check_mark: | Name of the workspace | Production | -| `slug` | *string* | :heavy_check_mark: | URL-friendly slug for the workspace | production | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the workspace was created | 2025-08-24T10:30:00Z | +| `createdBy` | *string* | ✅ | User ID of the workspace creator | user_abc123 | +| `defaultGuardrailId` | *string* | ✅ | Deterministic ID derived from the workspace ID. The default guardrail is materialized when its configuration is first written. | 595d5849-7e86-51fd-a7c0-705c34e4afff | +| `defaultImageModel` | *string* | ✅ | Default image model for this workspace | openai/dall-e-3 | +| `defaultProviderSort` | *string* | ✅ | Default provider sort preference (price, throughput, latency, exacto) | price | +| `defaultTextModel` | *string* | ✅ | Default text model for this workspace | openai/gpt-4o | +| `description` | *string* | ✅ | Description of the workspace | Production environment workspace | +| `disabledServerTools` | *string*[] | ➖ | OpenRouter server tools (e.g. openrouter:web_search) that requests in this workspace may not invoke. Null means no tools are disabled. | null | +| `id` | *string* | ✅ | Unique identifier for the workspace | 550e8400-e29b-41d4-a716-446655440000 | +| `includeByokInBudgets` | *boolean* | ➖ | Whether BYOK (bring-your-own-key) spend counts toward this workspace's budgets. Set it via the workspace budget endpoints. | false | +| `ioLoggingApiKeyIds` | *number*[] | ✅ | Optional array of API key IDs to filter I/O logging. Null means all keys are logged. | null | +| `ioLoggingSamplingRate` | *number* | ✅ | Sampling rate for I/O logging (0.0001-1). 1 means 100% of requests are logged. | 1 | +| `isDataDiscountLoggingEnabled` | *boolean* | ✅ | Whether data discount logging is enabled for this workspace | true | +| `isObservabilityBroadcastEnabled` | *boolean* | ✅ | Whether broadcast is enabled for this workspace | false | +| `isObservabilityIoLoggingEnabled` | *boolean* | ✅ | Whether private logging is enabled for this workspace | false | +| `name` | *string* | ✅ | Name of the workspace | Production | +| `slug` | *string* | ✅ | URL-friendly slug for the workspace | production | +| `updatedAt` | *string* | ✅ | ISO 8601 timestamp of when the workspace was last updated | 2025-08-24T15:45:00Z | \ No newline at end of file diff --git a/docs/models/workspacebudget.mdx b/docs/models/workspacebudget.mdx index f8867c7d9..1dc149a54 100644 --- a/docs/models/workspacebudget.mdx +++ b/docs/models/workspacebudget.mdx @@ -21,9 +21,9 @@ let value: WorkspaceBudget = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | -| `limitUsd` | *number* | :heavy_check_mark: | Spending limit in USD for this interval | 100 | -| `resetInterval` | [models.ResetInterval](../models/resetinterval.mdx) | :heavy_check_mark: | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | -| `updatedAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the budget was created | 2025-08-24T10:30:00Z | +| `id` | *string* | ✅ | Unique identifier for the budget | 770e8400-e29b-41d4-a716-446655440000 | +| `limitUsd` | *number* | ✅ | Spending limit in USD for this interval | 100 | +| `resetInterval` | [models.ResetInterval](../models/resetinterval.mdx) | ✅ | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | +| `updatedAt` | *string* | ✅ | ISO 8601 timestamp of when the budget was last updated | 2025-08-24T15:45:00Z | +| `workspaceId` | *string* | ✅ | ID of the workspace the budget belongs to | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/workspacemember.mdx b/docs/models/workspacemember.mdx index 48e475165..9729a1bfa 100644 --- a/docs/models/workspacemember.mdx +++ b/docs/models/workspacemember.mdx @@ -20,8 +20,8 @@ let value: WorkspaceMember = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `createdAt` | *string* | :heavy_check_mark: | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | -| `id` | *string* | :heavy_check_mark: | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | -| `role` | [models.WorkspaceMemberRole](../models/workspacememberrole.mdx) | :heavy_check_mark: | Role of the member in the workspace | member | -| `userId` | *string* | :heavy_check_mark: | Clerk user ID of the member | user_abc123 | -| `workspaceId` | *string* | :heavy_check_mark: | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file +| `createdAt` | *string* | ✅ | ISO 8601 timestamp of when the membership was created | 2025-08-24T10:30:00Z | +| `id` | *string* | ✅ | Unique identifier for the workspace membership | 660e8400-e29b-41d4-a716-446655440000 | +| `role` | [models.WorkspaceMemberRole](../models/workspacememberrole.mdx) | ✅ | Role of the member in the workspace | member | +| `userId` | *string* | ✅ | Clerk user ID of the member | user_abc123 | +| `workspaceId` | *string* | ✅ | ID of the workspace | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/xsearchoptions.mdx b/docs/models/xsearchoptions.mdx index 78f32ec35..78eb61394 100644 --- a/docs/models/xsearchoptions.mdx +++ b/docs/models/xsearchoptions.mdx @@ -16,9 +16,9 @@ let value: XSearchOptions = {}; | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `allowedXHandles` | *string*[] | :heavy_minus_sign: | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | -| `enableImageUnderstanding` | *boolean* | :heavy_minus_sign: | Analyze images attached to matching posts. | | -| `enableVideoUnderstanding` | *boolean* | :heavy_minus_sign: | Analyze videos attached to matching posts. | | -| `excludedXHandles` | *string*[] | :heavy_minus_sign: | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | -| `fromDate` | [RFCDate](../types/rfcdate.mdx) | :heavy_minus_sign: | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | -| `toDate` | [RFCDate](../types/rfcdate.mdx) | :heavy_minus_sign: | End of the post date range (ISO 8601 date, e.g. "2025-12-31"). | 2025-12-31 | \ No newline at end of file +| `allowedXHandles` | *string*[] | ➖ | Only include posts from these X handles (max 20). Cannot be used with excluded_x_handles. | [
"OpenRouterAI"
] | +| `enableImageUnderstanding` | *boolean* | ➖ | Analyze images attached to matching posts. | | +| `enableVideoUnderstanding` | *boolean* | ➖ | Analyze videos attached to matching posts. | | +| `excludedXHandles` | *string*[] | ➖ | Exclude posts from these X handles (max 20). Cannot be used with allowed_x_handles. | [
"spamaccount"
] | +| `fromDate` | [RFCDate](../types/rfcdate.mdx) | ➖ | Start of the post date range (ISO 8601 date, e.g. "2025-01-01"). | 2025-01-01 | +| `toDate` | [RFCDate](../types/rfcdate.mdx) | ➖ | End of the post date range (ISO 8601 date, e.g. "2025-12-31"). | 2025-12-31 | \ No newline at end of file diff --git a/docs/sdks/analytics/README.mdx b/docs/sdks/analytics/README.mdx index d83e642df..354984567 100644 --- a/docs/sdks/analytics/README.mdx +++ b/docs/sdks/analytics/README.mdx @@ -72,10 +72,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetUserActivityRequest](../../models/operations/getuseractivityrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetUserActivityRequest](../../models/operations/getuseractivityrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -151,10 +151,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetAnalyticsMetaRequest](../../models/operations/getanalyticsmetarequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetAnalyticsMetaRequest](../../models/operations/getanalyticsmetarequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -258,10 +258,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/apikeys/README.mdx b/docs/sdks/apikeys/README.mdx index 36cad6b72..135635f2a 100644 --- a/docs/sdks/apikeys/README.mdx +++ b/docs/sdks/apikeys/README.mdx @@ -75,10 +75,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetCurrentKeyRequest](../../models/operations/getcurrentkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetCurrentKeyRequest](../../models/operations/getcurrentkeyrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -151,10 +151,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListRequest](../../models/operations/listrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListRequest](../../models/operations/listrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -245,10 +245,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -328,10 +328,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteKeysRequest](../../models/operations/deletekeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteKeysRequest](../../models/operations/deletekeysrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -410,10 +410,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetKeyRequest](../../models/operations/getkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetKeyRequest](../../models/operations/getkeyrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -554,10 +554,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateKeysRequest](../../models/operations/updatekeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdateKeysRequest](../../models/operations/updatekeysrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/batch/README.mdx b/docs/sdks/batch/README.mdx index 51c33f632..5fbf8e1b3 100644 --- a/docs/sdks/batch/README.mdx +++ b/docs/sdks/batch/README.mdx @@ -77,10 +77,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListBatchesRequest](../../models/operations/listbatchesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListBatchesRequest](../../models/operations/listbatchesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -467,10 +467,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateBatchesRequest](../../models/operations/createbatchesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateBatchesRequest](../../models/operations/createbatchesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -547,10 +547,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteBatchRequest](../../models/operations/deletebatchrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteBatchRequest](../../models/operations/deletebatchrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -627,10 +627,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetBatchesRequest](../../models/operations/getbatchesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetBatchesRequest](../../models/operations/getbatchesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/benchmarks/README.mdx b/docs/sdks/benchmarks/README.mdx index 2733b7c45..16cae1bbf 100644 --- a/docs/sdks/benchmarks/README.mdx +++ b/docs/sdks/benchmarks/README.mdx @@ -70,10 +70,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/betaresponses/README.mdx b/docs/sdks/betaresponses/README.mdx index 36034dd52..79b9d97c9 100644 --- a/docs/sdks/betaresponses/README.mdx +++ b/docs/sdks/betaresponses/README.mdx @@ -128,10 +128,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateResponsesRequest](../../models/operations/createresponsesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateResponsesRequest](../../models/operations/createresponsesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/byok/README.mdx b/docs/sdks/byok/README.mdx index 92595fd27..ebf676427 100644 --- a/docs/sdks/byok/README.mdx +++ b/docs/sdks/byok/README.mdx @@ -78,10 +78,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListBYOKKeysRequest](../../models/operations/listbyokkeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListBYOKKeysRequest](../../models/operations/listbyokkeysrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -167,10 +167,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateBYOKKeyRequest](../../models/operations/createbyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateBYOKKeyRequest](../../models/operations/createbyokkeyrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -249,10 +249,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteBYOKKeyRequest](../../models/operations/deletebyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteBYOKKeyRequest](../../models/operations/deletebyokkeyrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -330,10 +330,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetBYOKKeyRequest](../../models/operations/getbyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetBYOKKeyRequest](../../models/operations/getbyokkeyrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -419,10 +419,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateBYOKKeyRequest](../../models/operations/updatebyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdateBYOKKeyRequest](../../models/operations/updatebyokkeyrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/chat/README.mdx b/docs/sdks/chat/README.mdx index e8d58be47..b5e111e90 100644 --- a/docs/sdks/chat/README.mdx +++ b/docs/sdks/chat/README.mdx @@ -169,10 +169,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.SendChatCompletionRequestRequest](../../models/operations/sendchatcompletionrequestrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.SendChatCompletionRequestRequest](../../models/operations/sendchatcompletionrequestrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/classifications/README.mdx b/docs/sdks/classifications/README.mdx index b81073c24..4a05c3a66 100644 --- a/docs/sdks/classifications/README.mdx +++ b/docs/sdks/classifications/README.mdx @@ -88,10 +88,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetTaskClassificationsRequest](../../models/operations/gettaskclassificationsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetTaskClassificationsRequest](../../models/operations/gettaskclassificationsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/containers/README.mdx b/docs/sdks/containers/README.mdx index 341465625..3b86fb1a9 100644 --- a/docs/sdks/containers/README.mdx +++ b/docs/sdks/containers/README.mdx @@ -77,10 +77,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListContainerFilesRequest](../../models/operations/listcontainerfilesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListContainerFilesRequest](../../models/operations/listcontainerfilesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -163,10 +163,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetContainerFileRequest](../../models/operations/getcontainerfilerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetContainerFileRequest](../../models/operations/getcontainerfilerequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -250,10 +250,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DownloadContainerFileContentRequest](../../models/operations/downloadcontainerfilecontentrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DownloadContainerFileContentRequest](../../models/operations/downloadcontainerfilecontentrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -337,10 +337,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.PromoteContainerFileRequest](../../models/operations/promotecontainerfilerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.PromoteContainerFileRequest](../../models/operations/promotecontainerfilerequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/credits/README.mdx b/docs/sdks/credits/README.mdx index 20b3a9f4b..b5a51e3bc 100644 --- a/docs/sdks/credits/README.mdx +++ b/docs/sdks/credits/README.mdx @@ -70,10 +70,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetCreditsRequest](../../models/operations/getcreditsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetCreditsRequest](../../models/operations/getcreditsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/datasets/README.mdx b/docs/sdks/datasets/README.mdx index 0b972989c..4dd37f0d9 100644 --- a/docs/sdks/datasets/README.mdx +++ b/docs/sdks/datasets/README.mdx @@ -100,10 +100,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -205,10 +205,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -295,10 +295,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetSessionCostRequest](../../models/operations/getsessioncostrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetSessionCostRequest](../../models/operations/getsessioncostrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/decisions/README.mdx b/docs/sdks/decisions/README.mdx index ca2390f49..fc4652c77 100644 --- a/docs/sdks/decisions/README.mdx +++ b/docs/sdks/decisions/README.mdx @@ -142,11 +142,11 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateApiAlphaDecisionsRequest](../../models/operations/createapialphadecisionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | -| `options.serverURL` | *string* | :heavy_minus_sign: | An optional server URL to use. | +| `request` | [operations.CreateApiAlphaDecisionsRequest](../../models/operations/createapialphadecisionsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | +| `options.serverURL` | *string* | ➖ | An optional server URL to use. | ### Response diff --git a/docs/sdks/embeddings/README.mdx b/docs/sdks/embeddings/README.mdx index 238a10055..cd78d8c6c 100644 --- a/docs/sdks/embeddings/README.mdx +++ b/docs/sdks/embeddings/README.mdx @@ -81,10 +81,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -173,10 +173,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEmbeddingsModelsRequest](../../models/operations/listembeddingsmodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListEmbeddingsModelsRequest](../../models/operations/listembeddingsmodelsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/endpoints/README.mdx b/docs/sdks/endpoints/README.mdx index 6629f1c02..e57b07ef8 100644 --- a/docs/sdks/endpoints/README.mdx +++ b/docs/sdks/endpoints/README.mdx @@ -71,10 +71,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEndpointsZdrRequest](../../models/operations/listendpointszdrrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListEndpointsZdrRequest](../../models/operations/listendpointszdrrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -153,10 +153,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEndpointsRequest](../../models/operations/listendpointsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListEndpointsRequest](../../models/operations/listendpointsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/endusers/README.mdx b/docs/sdks/endusers/README.mdx index a25075e64..799d8d5d9 100644 --- a/docs/sdks/endusers/README.mdx +++ b/docs/sdks/endusers/README.mdx @@ -78,10 +78,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListEndUsersRequest](../../models/operations/listendusersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListEndUsersRequest](../../models/operations/listendusersrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -164,10 +164,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateEndUserRequest](../../models/operations/createenduserrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateEndUserRequest](../../models/operations/createenduserrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -247,10 +247,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteEndUserRequest](../../models/operations/deleteenduserrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteEndUserRequest](../../models/operations/deleteenduserrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -329,10 +329,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetEndUserRequest](../../models/operations/getenduserrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetEndUserRequest](../../models/operations/getenduserrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -417,10 +417,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateEndUserRequest](../../models/operations/updateenduserrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdateEndUserRequest](../../models/operations/updateenduserrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/files/README.mdx b/docs/sdks/files/README.mdx index 295c739e9..d7492739e 100644 --- a/docs/sdks/files/README.mdx +++ b/docs/sdks/files/README.mdx @@ -78,10 +78,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -171,10 +171,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UploadFileRequest](../../models/operations/uploadfilerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UploadFileRequest](../../models/operations/uploadfilerequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -259,10 +259,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteFileRequest](../../models/operations/deletefilerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteFileRequest](../../models/operations/deletefilerequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -346,10 +346,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetFileMetadataRequest](../../models/operations/getfilemetadatarequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetFileMetadataRequest](../../models/operations/getfilemetadatarequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -433,10 +433,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DownloadFileContentRequest](../../models/operations/downloadfilecontentrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DownloadFileContentRequest](../../models/operations/downloadfilecontentrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/generations/README.mdx b/docs/sdks/generations/README.mdx index a82cc0ed7..099eaad82 100644 --- a/docs/sdks/generations/README.mdx +++ b/docs/sdks/generations/README.mdx @@ -76,10 +76,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetGenerationRequest](../../models/operations/getgenerationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetGenerationRequest](../../models/operations/getgenerationrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -163,10 +163,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGenerationContentRequest](../../models/operations/listgenerationcontentrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListGenerationContentRequest](../../models/operations/listgenerationcontentrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -258,10 +258,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.SubmitGenerationFeedbackRequest](../../models/operations/submitgenerationfeedbackrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.SubmitGenerationFeedbackRequest](../../models/operations/submitgenerationfeedbackrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/guardrails/README.mdx b/docs/sdks/guardrails/README.mdx index 674979300..95d9e8478 100644 --- a/docs/sdks/guardrails/README.mdx +++ b/docs/sdks/guardrails/README.mdx @@ -86,10 +86,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGuardrailsRequest](../../models/operations/listguardrailsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListGuardrailsRequest](../../models/operations/listguardrailsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -209,10 +209,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateGuardrailRequest](../../models/operations/createguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateGuardrailRequest](../../models/operations/createguardrailrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -291,10 +291,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteGuardrailRequest](../../models/operations/deleteguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteGuardrailRequest](../../models/operations/deleteguardrailrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -372,10 +372,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetGuardrailRequest](../../models/operations/getguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetGuardrailRequest](../../models/operations/getguardrailrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -465,10 +465,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateGuardrailRequest](../../models/operations/updateguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdateGuardrailRequest](../../models/operations/updateguardrailrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -553,10 +553,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGuardrailKeyAssignmentsRequest](../../models/operations/listguardrailkeyassignmentsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListGuardrailKeyAssignmentsRequest](../../models/operations/listguardrailkeyassignmentsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -644,10 +644,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkAssignKeysToGuardrailRequest](../../models/operations/bulkassignkeystoguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.BulkAssignKeysToGuardrailRequest](../../models/operations/bulkassignkeystoguardrailrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -737,10 +737,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkUnassignKeysFromGuardrailRequest](../../models/operations/bulkunassignkeysfromguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.BulkUnassignKeysFromGuardrailRequest](../../models/operations/bulkunassignkeysfromguardrailrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -823,10 +823,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListGuardrailMemberAssignmentsRequest](../../models/operations/listguardrailmemberassignmentsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListGuardrailMemberAssignmentsRequest](../../models/operations/listguardrailmemberassignmentsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -916,10 +916,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkAssignMembersToGuardrailRequest](../../models/operations/bulkassignmemberstoguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.BulkAssignMembersToGuardrailRequest](../../models/operations/bulkassignmemberstoguardrailrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -1010,10 +1010,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkUnassignMembersFromGuardrailRequest](../../models/operations/bulkunassignmembersfromguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.BulkUnassignMembersFromGuardrailRequest](../../models/operations/bulkunassignmembersfromguardrailrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -1092,10 +1092,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListKeyAssignmentsRequest](../../models/operations/listkeyassignmentsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListKeyAssignmentsRequest](../../models/operations/listkeyassignmentsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -1172,10 +1172,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListMemberAssignmentsRequest](../../models/operations/listmemberassignmentsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListMemberAssignmentsRequest](../../models/operations/listmemberassignmentsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/images/README.mdx b/docs/sdks/images/README.mdx index 15b7b4c80..04a3fb457 100644 --- a/docs/sdks/images/README.mdx +++ b/docs/sdks/images/README.mdx @@ -82,10 +82,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateImagesRequest](../../models/operations/createimagesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateImagesRequest](../../models/operations/createimagesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -167,10 +167,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListImageModelsRequest](../../models/operations/listimagemodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListImageModelsRequest](../../models/operations/listimagemodelsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -248,10 +248,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListImageModelEndpointsRequest](../../models/operations/listimagemodelendpointsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListImageModelEndpointsRequest](../../models/operations/listimagemodelendpointsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/interns/README.mdx b/docs/sdks/interns/README.mdx index 58668ffc9..0632a7ff7 100644 --- a/docs/sdks/interns/README.mdx +++ b/docs/sdks/interns/README.mdx @@ -15,7 +15,7 @@ Create, inspect, update, provision, suspend and delete OpenRouter interns throug * [getIntern](#getintern) - Get an intern * [updateIntern](#updateintern) - Update an intern * [getInternDaemon](#getinterndaemon) - Get an intern's daemon access -* [~~getInternDaemonAccess~~](#getinterndaemonaccess) - Get an intern's daemon access (deprecated alias) :warning: **Deprecated** +* [~~getInternDaemonAccess~~](#getinterndaemonaccess) - Get an intern's daemon access (deprecated alias) ⚠️ **Deprecated** * [provisionIntern](#provisionintern) - Provision an intern * [suspendIntern](#suspendintern) - Suspend an intern * [chat](#chat) - Stream a chat completion with an intern @@ -80,10 +80,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListInternsRequest](../../models/operations/listinternsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListInternsRequest](../../models/operations/listinternsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -168,10 +168,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateInternRequest](../../models/operations/createinternrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateInternRequest](../../models/operations/createinternrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -254,10 +254,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteInternRequest](../../models/operations/deleteinternrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteInternRequest](../../models/operations/deleteinternrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -334,10 +334,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetInternRequest](../../models/operations/getinternrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetInternRequest](../../models/operations/getinternrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -422,10 +422,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateInternRequest](../../models/operations/updateinternrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdateInternRequest](../../models/operations/updateinternrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -502,10 +502,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetInternDaemonRequest](../../models/operations/getinterndaemonrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetInternDaemonRequest](../../models/operations/getinterndaemonrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -523,7 +523,7 @@ run(); Deprecated alias of `GET /interns/{internId}/daemon` with the same request, response, and errors. The API key selects the caller, workspace and visible interns. An intern's own API key sees only that intern: the collection and every other intern answer 404 to it. There is no default workspace fallback. Requests on regional hostnames such as `eu.openrouter.ai` are refused. [API key](/docs/api-reference/authentication) required. -> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. +> ⚠️ **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -584,10 +584,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetInternDaemonAccessRequest](../../models/operations/getinterndaemonaccessrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetInternDaemonAccessRequest](../../models/operations/getinterndaemonaccessrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -664,10 +664,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ProvisionInternRequest](../../models/operations/provisioninternrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ProvisionInternRequest](../../models/operations/provisioninternrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -744,10 +744,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.SuspendInternRequest](../../models/operations/suspendinternrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.SuspendInternRequest](../../models/operations/suspendinternrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -860,10 +860,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateInternChatCompletionRequest](../../models/operations/createinternchatcompletionrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateInternChatCompletionRequest](../../models/operations/createinternchatcompletionrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -954,10 +954,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.InvokeInternRequest](../../models/operations/invokeinternrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.InvokeInternRequest](../../models/operations/invokeinternrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/models/README.mdx b/docs/sdks/models/README.mdx index 30b32e7ce..e6287ca32 100644 --- a/docs/sdks/models/README.mdx +++ b/docs/sdks/models/README.mdx @@ -79,10 +79,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetModelRequest](../../models/operations/getmodelrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetModelRequest](../../models/operations/getmodelrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -160,10 +160,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -237,10 +237,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListModelsCountRequest](../../models/operations/listmodelscountrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListModelsCountRequest](../../models/operations/listmodelscountrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -320,11 +320,11 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListModelsUserRequest](../../models/operations/listmodelsuserrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListModelsUserRequest](../../models/operations/listmodelsuserrequest.mdx) | ✅ | The request object to use for the request. | +| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity.mdx) | ✅ | The security requirements to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/oauth/README.mdx b/docs/sdks/oauth/README.mdx index a9ad863a2..953b522a5 100644 --- a/docs/sdks/oauth/README.mdx +++ b/docs/sdks/oauth/README.mdx @@ -85,10 +85,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -176,10 +176,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -255,10 +255,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListOauthJwksRequest](../../models/operations/listoauthjwksrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListOauthJwksRequest](../../models/operations/listoauthjwksrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -344,10 +344,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateOauthTokenRequest](../../models/operations/createoauthtokenrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateOauthTokenRequest](../../models/operations/createoauthtokenrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/observability/README.mdx b/docs/sdks/observability/README.mdx index 17946fdd6..38d865ae0 100644 --- a/docs/sdks/observability/README.mdx +++ b/docs/sdks/observability/README.mdx @@ -78,10 +78,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListObservabilityDestinationsRequest](../../models/operations/listobservabilitydestinationsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListObservabilityDestinationsRequest](../../models/operations/listobservabilitydestinationsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -175,10 +175,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateObservabilityDestinationRequest](../../models/operations/createobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateObservabilityDestinationRequest](../../models/operations/createobservabilitydestinationrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -258,10 +258,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteObservabilityDestinationRequest](../../models/operations/deleteobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteObservabilityDestinationRequest](../../models/operations/deleteobservabilitydestinationrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -339,10 +339,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetObservabilityDestinationRequest](../../models/operations/getobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetObservabilityDestinationRequest](../../models/operations/getobservabilitydestinationrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -428,10 +428,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateObservabilityDestinationRequest](../../models/operations/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdateObservabilityDestinationRequest](../../models/operations/updateobservabilitydestinationrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/organization/README.mdx b/docs/sdks/organization/README.mdx index fdbefc1ca..abd0d7bf7 100644 --- a/docs/sdks/organization/README.mdx +++ b/docs/sdks/organization/README.mdx @@ -76,10 +76,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListOrganizationMembersRequest](../../models/operations/listorganizationmembersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListOrganizationMembersRequest](../../models/operations/listorganizationmembersrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -153,10 +153,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetOrganizationSettingsRequest](../../models/operations/getorganizationsettingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetOrganizationSettingsRequest](../../models/operations/getorganizationsettingsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -238,10 +238,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateOrganizationSettingsRequest](../../models/operations/updateorganizationsettingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdateOrganizationSettingsRequest](../../models/operations/updateorganizationsettingsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/presets/README.mdx b/docs/sdks/presets/README.mdx index ca3de1fb0..d65048a06 100644 --- a/docs/sdks/presets/README.mdx +++ b/docs/sdks/presets/README.mdx @@ -80,10 +80,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListPresetsRequest](../../models/operations/listpresetsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListPresetsRequest](../../models/operations/listpresetsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -161,10 +161,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetPresetRequest](../../models/operations/getpresetrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetPresetRequest](../../models/operations/getpresetrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -271,10 +271,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePresetsChatCompletionsRequest](../../models/operations/createpresetschatcompletionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreatePresetsChatCompletionsRequest](../../models/operations/createpresetschatcompletionsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -377,10 +377,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePresetsMessagesRequest](../../models/operations/createpresetsmessagesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreatePresetsMessagesRequest](../../models/operations/createpresetsmessagesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -471,10 +471,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePresetsResponsesRequest](../../models/operations/createpresetsresponsesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreatePresetsResponsesRequest](../../models/operations/createpresetsresponsesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -559,10 +559,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListPresetVersionsRequest](../../models/operations/listpresetversionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListPresetVersionsRequest](../../models/operations/listpresetversionsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -643,10 +643,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetPresetVersionRequest](../../models/operations/getpresetversionrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetPresetVersionRequest](../../models/operations/getpresetversionrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/privateendpoints/README.mdx b/docs/sdks/privateendpoints/README.mdx index 5c99c685a..16270201a 100644 --- a/docs/sdks/privateendpoints/README.mdx +++ b/docs/sdks/privateendpoints/README.mdx @@ -79,10 +79,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListPrivateEndpointsRequest](../../models/operations/listprivateendpointsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListPrivateEndpointsRequest](../../models/operations/listprivateendpointsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -169,10 +169,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreatePrivateEndpointRequest](../../models/operations/createprivateendpointrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreatePrivateEndpointRequest](../../models/operations/createprivateendpointrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -261,10 +261,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeletePrivateEndpointRequest](../../models/operations/deleteprivateendpointrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeletePrivateEndpointRequest](../../models/operations/deleteprivateendpointrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -348,10 +348,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetPrivateEndpointRequest](../../models/operations/getprivateendpointrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetPrivateEndpointRequest](../../models/operations/getprivateendpointrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -437,10 +437,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdatePrivateEndpointRequest](../../models/operations/updateprivateendpointrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdatePrivateEndpointRequest](../../models/operations/updateprivateendpointrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -524,10 +524,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ActivatePrivateEndpointRequest](../../models/operations/activateprivateendpointrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ActivatePrivateEndpointRequest](../../models/operations/activateprivateendpointrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -611,10 +611,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DisablePrivateEndpointRequest](../../models/operations/disableprivateendpointrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DisablePrivateEndpointRequest](../../models/operations/disableprivateendpointrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -698,10 +698,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.EnablePrivateEndpointRequest](../../models/operations/enableprivateendpointrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.EnablePrivateEndpointRequest](../../models/operations/enableprivateendpointrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -797,10 +797,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdatePrivateEndpointPricingRequest](../../models/operations/updateprivateendpointpricingrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdatePrivateEndpointPricingRequest](../../models/operations/updateprivateendpointpricingrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -890,10 +890,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ValidatePrivateEndpointRequest](../../models/operations/validateprivateendpointrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ValidatePrivateEndpointRequest](../../models/operations/validateprivateendpointrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/providers/README.mdx b/docs/sdks/providers/README.mdx index 55ca92d25..93ee412b9 100644 --- a/docs/sdks/providers/README.mdx +++ b/docs/sdks/providers/README.mdx @@ -70,10 +70,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListProvidersRequest](../../models/operations/listprovidersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListProvidersRequest](../../models/operations/listprovidersrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/rerank/README.mdx b/docs/sdks/rerank/README.mdx index 56314758b..c94868371 100644 --- a/docs/sdks/rerank/README.mdx +++ b/docs/sdks/rerank/README.mdx @@ -88,10 +88,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/responses/README.mdx b/docs/sdks/responses/README.mdx index a6ae7a34a..53fa92265 100644 --- a/docs/sdks/responses/README.mdx +++ b/docs/sdks/responses/README.mdx @@ -128,10 +128,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateResponsesRequest](../../models/operations/createresponsesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateResponsesRequest](../../models/operations/createresponsesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/scim/README.mdx b/docs/sdks/scim/README.mdx index 5395d7341..f7e83c6ae 100644 --- a/docs/sdks/scim/README.mdx +++ b/docs/sdks/scim/README.mdx @@ -81,10 +81,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListScimGroupMappingsRequest](../../models/operations/listscimgroupmappingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListScimGroupMappingsRequest](../../models/operations/listscimgroupmappingsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -170,10 +170,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateScimGroupMappingRequest](../../models/operations/createscimgroupmappingrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateScimGroupMappingRequest](../../models/operations/createscimgroupmappingrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -255,10 +255,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteScimGroupMappingRequest](../../models/operations/deletescimgroupmappingrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteScimGroupMappingRequest](../../models/operations/deletescimgroupmappingrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -337,10 +337,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetScimGroupMappingRequest](../../models/operations/getscimgroupmappingrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetScimGroupMappingRequest](../../models/operations/getscimgroupmappingrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -424,10 +424,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateScimGroupMappingRequest](../../models/operations/updatescimgroupmappingrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdateScimGroupMappingRequest](../../models/operations/updatescimgroupmappingrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -506,10 +506,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListScimGroupsRequest](../../models/operations/listscimgroupsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListScimGroupsRequest](../../models/operations/listscimgroupsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -583,10 +583,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateScimSyncJobRequest](../../models/operations/createscimsyncjobrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateScimSyncJobRequest](../../models/operations/createscimsyncjobrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -664,10 +664,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetScimSyncJobRequest](../../models/operations/getscimsyncjobrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetScimSyncJobRequest](../../models/operations/getscimsyncjobrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/stt/README.mdx b/docs/sdks/stt/README.mdx index 5dfd88bc4..9430e5855 100644 --- a/docs/sdks/stt/README.mdx +++ b/docs/sdks/stt/README.mdx @@ -89,10 +89,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAudioTranscriptionsRequest](../../models/operations/createaudiotranscriptionsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateAudioTranscriptionsRequest](../../models/operations/createaudiotranscriptionsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -190,10 +190,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/systemone/README.mdx b/docs/sdks/systemone/README.mdx index b537f54a2..8912bc2f6 100644 --- a/docs/sdks/systemone/README.mdx +++ b/docs/sdks/systemone/README.mdx @@ -142,10 +142,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateSystemoneRequest](../../models/operations/createsystemonerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateSystemoneRequest](../../models/operations/createsystemonerequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/tools/README.mdx b/docs/sdks/tools/README.mdx index 6a9650d01..1e5d54c51 100644 --- a/docs/sdks/tools/README.mdx +++ b/docs/sdks/tools/README.mdx @@ -73,11 +73,11 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListToolsRequest](../../models/operations/listtoolsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `security` | [operations.ListToolsSecurity](../../models/operations/listtoolssecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListToolsRequest](../../models/operations/listtoolsrequest.mdx) | ✅ | The request object to use for the request. | +| `security` | [operations.ListToolsSecurity](../../models/operations/listtoolssecurity.mdx) | ✅ | The security requirements to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -158,11 +158,11 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetToolRequest](../../models/operations/gettoolrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `security` | [operations.GetToolSecurity](../../models/operations/gettoolsecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetToolRequest](../../models/operations/gettoolrequest.mdx) | ✅ | The request object to use for the request. | +| `security` | [operations.GetToolSecurity](../../models/operations/gettoolsecurity.mdx) | ✅ | The security requirements to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/tts/README.mdx b/docs/sdks/tts/README.mdx index f268a9890..bed5f42ee 100644 --- a/docs/sdks/tts/README.mdx +++ b/docs/sdks/tts/README.mdx @@ -84,10 +84,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateAudioSpeechRequest](../../models/operations/createaudiospeechrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateAudioSpeechRequest](../../models/operations/createaudiospeechrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/vault/README.mdx b/docs/sdks/vault/README.mdx index f537caf25..6d9ef7374 100644 --- a/docs/sdks/vault/README.mdx +++ b/docs/sdks/vault/README.mdx @@ -83,10 +83,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListInternEffectiveVaultSecretsRequest](../../models/operations/listinterneffectivevaultsecretsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListInternEffectiveVaultSecretsRequest](../../models/operations/listinterneffectivevaultsecretsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -173,10 +173,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListInternVaultSecretsRequest](../../models/operations/listinternvaultsecretsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListInternVaultSecretsRequest](../../models/operations/listinternvaultsecretsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -263,10 +263,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteInternVaultSecretRequest](../../models/operations/deleteinternvaultsecretrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteInternVaultSecretRequest](../../models/operations/deleteinternvaultsecretrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -1385,10 +1385,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.StoreInternVaultSecretRequest](../../models/operations/storeinternvaultsecretrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.StoreInternVaultSecretRequest](../../models/operations/storeinternvaultsecretrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -2445,10 +2445,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CopyVaultSecretsToInternRequest](../../models/operations/copyvaultsecretstointernrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CopyVaultSecretsToInternRequest](../../models/operations/copyvaultsecretstointernrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -2531,10 +2531,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListVaultSecretsRequest](../../models/operations/listvaultsecretsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListVaultSecretsRequest](../../models/operations/listvaultsecretsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -2619,10 +2619,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteVaultSecretRequest](../../models/operations/deletevaultsecretrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteVaultSecretRequest](../../models/operations/deletevaultsecretrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -3643,10 +3643,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.StoreVaultSecretRequest](../../models/operations/storevaultsecretrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.StoreVaultSecretRequest](../../models/operations/storevaultsecretrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/videogeneration/README.mdx b/docs/sdks/videogeneration/README.mdx index 37374134e..93dcd58ec 100644 --- a/docs/sdks/videogeneration/README.mdx +++ b/docs/sdks/videogeneration/README.mdx @@ -89,10 +89,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateVideosRequest](../../models/operations/createvideosrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateVideosRequest](../../models/operations/createvideosrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -175,10 +175,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetVideosRequest](../../models/operations/getvideosrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetVideosRequest](../../models/operations/getvideosrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -257,10 +257,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListVideosContentRequest](../../models/operations/listvideoscontentrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListVideosContentRequest](../../models/operations/listvideoscontentrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -339,10 +339,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListVideosModelsRequest](../../models/operations/listvideosmodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListVideosModelsRequest](../../models/operations/listvideosmodelsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/docs/sdks/workspaces/README.mdx b/docs/sdks/workspaces/README.mdx index 58f1fd910..44cbe96c2 100644 --- a/docs/sdks/workspaces/README.mdx +++ b/docs/sdks/workspaces/README.mdx @@ -85,10 +85,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListWorkspacesRequest](../../models/operations/listworkspacesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListWorkspacesRequest](../../models/operations/listworkspacesrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -179,10 +179,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.CreateWorkspaceRequest](../../models/operations/createworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.CreateWorkspaceRequest](../../models/operations/createworkspacerequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -261,10 +261,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteWorkspaceRequest](../../models/operations/deleteworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteWorkspaceRequest](../../models/operations/deleteworkspacerequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -344,10 +344,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetWorkspaceRequest](../../models/operations/getworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetWorkspaceRequest](../../models/operations/getworkspacerequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -433,10 +433,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpdateWorkspaceRequest](../../models/operations/updateworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpdateWorkspaceRequest](../../models/operations/updateworkspacerequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -520,10 +520,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListWorkspaceMembersRequest](../../models/operations/listworkspacemembersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListWorkspaceMembersRequest](../../models/operations/listworkspacemembersrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -614,10 +614,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkAddWorkspaceMembersRequest](../../models/operations/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.BulkAddWorkspaceMembersRequest](../../models/operations/bulkaddworkspacemembersrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -709,10 +709,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.BulkRemoveWorkspaceMembersRequest](../../models/operations/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.BulkRemoveWorkspaceMembersRequest](../../models/operations/bulkremoveworkspacemembersrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -792,10 +792,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.ListWorkspaceBudgetsRequest](../../models/operations/listworkspacebudgetsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.ListWorkspaceBudgetsRequest](../../models/operations/listworkspacebudgetsrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -875,10 +875,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.DeleteWorkspaceBudgetRequest](../../models/operations/deleteworkspacebudgetrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.DeleteWorkspaceBudgetRequest](../../models/operations/deleteworkspacebudgetrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -959,10 +959,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.GetWorkspaceBudgetRequest](../../models/operations/getworkspacebudgetrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.GetWorkspaceBudgetRequest](../../models/operations/getworkspacebudgetrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response @@ -1051,10 +1051,10 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.UpsertWorkspaceBudgetRequest](../../models/operations/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | -| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | -| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | +| `request` | [operations.UpsertWorkspaceBudgetRequest](../../models/operations/upsertworkspacebudgetrequest.mdx) | ✅ | The request object to use for the request. | +| `options` | RequestOptions | ➖ | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.mdx) | ➖ | Enables retrying HTTP requests under certain failure conditions. | ### Response diff --git a/scripts/sanitize-docs-emoji.sh b/scripts/sanitize-docs-emoji.sh new file mode 100755 index 000000000..f0e6ee972 --- /dev/null +++ b/scripts/sanitize-docs-emoji.sh @@ -0,0 +1,29 @@ +#!/usr/bin/env bash +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +cd "$ROOT" + +DOCS_DIR="docs" + +if [[ ! -d "$DOCS_DIR" ]]; then + echo "missing $DOCS_DIR" >&2 + exit 1 +fi + +find "$DOCS_DIR" -type f -name '*.mdx' -exec perl -0pi -e ' + s/:heavy_check_mark:/✅/g; + s/:heavy_minus_sign:/➖/g; + s/:warning:/⚠️/g; +' {} + + +# perl rather than grep -P so the guard also works on BSD/macOS; a scan error aborts via set -e. +matches="$(find "$DOCS_DIR" -type f -name '*.mdx' -exec perl -ne ' + print "$ARGV:$.:$_" if /(?&2 + printf '%s\n' "$matches" >&2 + exit 1 +fi