diff --git a/.github/workflows/docs-nav.yaml b/.github/workflows/docs-nav.yaml index fc4c8152..be391125 100644 --- a/.github/workflows/docs-nav.yaml +++ b/.github/workflows/docs-nav.yaml @@ -8,8 +8,9 @@ on: workflow_dispatch: pull_request: paths: - - "docs/sdks/**" + - "docs/**" - "scripts/gen-docs-nav.sh" + - "scripts/fix-docs-links.sh" - ".github/workflows/docs-nav.yaml" jobs: @@ -26,7 +27,10 @@ jobs: - name: Regenerate docs navigation run: scripts/gen-docs-nav.sh - - name: Auto-commit docs.json navigation + - name: Strip .mdx extensions from docs links + run: scripts/fix-docs-links.sh + + - name: Auto-commit docs post-processing uses: int128/update-generated-files-action@v2 with: - commit-message: "Chore: regenerate docs navigation" + commit-message: "Chore: regenerate docs navigation and fix docs links" diff --git a/docs/models/components/actionfindinpage.mdx b/docs/models/components/actionfindinpage.mdx index 5b990439..d05e9551 100644 --- a/docs/models/components/actionfindinpage.mdx +++ b/docs/models/components/actionfindinpage.mdx @@ -7,5 +7,5 @@ title: "ActionFindInPage" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `Pattern` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeFindInPage](../../models/components/typefindinpage.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeFindInPage](../../models/components/typefindinpage) | :heavy_check_mark: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/actionopenpage.mdx b/docs/models/components/actionopenpage.mdx index 713a959e..28435f94 100644 --- a/docs/models/components/actionopenpage.mdx +++ b/docs/models/components/actionopenpage.mdx @@ -6,5 +6,5 @@ title: "ActionOpenPage" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Type` | [components.TypeOpenPage](../../models/components/typeopenpage.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeOpenPage](../../models/components/typeopenpage) | :heavy_check_mark: | N/A | | `URL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/activityresponse.mdx b/docs/models/components/activityresponse.mdx index 4fd6bd11..b2619455 100644 --- a/docs/models/components/activityresponse.mdx +++ b/docs/models/components/activityresponse.mdx @@ -6,4 +6,4 @@ title: "ActivityResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Data` | [][components.ActivityItem](../../models/components/activityitem.mdx) | :heavy_check_mark: | List of activity items | \ No newline at end of file +| `Data` | [][components.ActivityItem](../../models/components/activityitem) | :heavy_check_mark: | List of activity items | \ No newline at end of file diff --git a/docs/models/components/additionaltoolsitem.mdx b/docs/models/components/additionaltoolsitem.mdx index 3c00f4bd..24a68c58 100644 --- a/docs/models/components/additionaltoolsitem.mdx +++ b/docs/models/components/additionaltoolsitem.mdx @@ -10,6 +10,6 @@ Additional tools made available to the model at this point in the input | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Role` | [components.AdditionalToolsItemRole](../../models/components/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A | -| `Tools` | [][components.AdditionalToolsItemToolUnion](../../models/components/additionaltoolsitemtoolunion.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.TypeAdditionalTools](../../models/components/typeadditionaltools.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Role` | [components.AdditionalToolsItemRole](../../models/components/additionaltoolsitemrole) | :heavy_check_mark: | N/A | +| `Tools` | [][components.AdditionalToolsItemToolUnion](../../models/components/additionaltoolsitemtoolunion) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeAdditionalTools](../../models/components/typeadditionaltools) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/additionaltoolsitemtoolfunction.mdx b/docs/models/components/additionaltoolsitemtoolfunction.mdx index aa133f17..75b78208 100644 --- a/docs/models/components/additionaltoolsitemtoolfunction.mdx +++ b/docs/models/components/additionaltoolsitemtoolfunction.mdx @@ -13,4 +13,4 @@ Function tool definition | `Name` | `string` | :heavy_check_mark: | N/A | | `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | -| `Type` | [components.AdditionalToolsItemTypeFunction](../../models/components/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AdditionalToolsItemTypeFunction](../../models/components/additionaltoolsitemtypefunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/advisorreasoning.mdx b/docs/models/components/advisorreasoning.mdx index e1eb8f5f..33bd3946 100644 --- a/docs/models/components/advisorreasoning.mdx +++ b/docs/models/components/advisorreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the advisor call. Use this to control reaso | Field | Type | Required | Description | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `Effort` | [*components.AdvisorReasoningEffort](../../models/components/advisorreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the advisor call. | +| `Effort` | [*components.AdvisorReasoningEffort](../../models/components/advisorreasoningeffort) | :heavy_minus_sign: | Reasoning effort level for the advisor call. | | `MaxTokens` | `*int64` | :heavy_minus_sign: | Maximum number of reasoning tokens the advisor may use. | \ No newline at end of file diff --git a/docs/models/components/advisorservertoolconfig.mdx b/docs/models/components/advisorservertoolconfig.mdx index 32e40c52..5f729042 100644 --- a/docs/models/components/advisorservertoolconfig.mdx +++ b/docs/models/components/advisorservertoolconfig.mdx @@ -15,7 +15,7 @@ Configuration for one openrouter:advisor server tool entry. | `MaxToolCalls` | `*int64` | :heavy_minus_sign: | Maximum number of tool-calling steps the advisor sub-agent may take during its agentic loop. Capped at 25. Only relevant when the advisor is given tools. | 5 | | `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. The advisor tool itself cannot be the advisor model. | ~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` | [*components.AdvisorReasoning](../../models/components/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"
} | +| `Reasoning` | [*components.AdvisorReasoning](../../models/components/advisorreasoning) | :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` | `*bool` | :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` | `*float64` | :heavy_minus_sign: | Sampling temperature forwarded to the advisor call. When omitted, the provider's default applies. | 0.7 | -| `Tools` | [][components.AdvisorNestedTool](../../models/components/advisornestedtool.mdx) | :heavy_minus_sign: | Tools the advisor sub-agent may use while forming its advice. The advisor runs as an agentic sub-agent over these tools, then returns its text. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the advisor tool itself. | | \ No newline at end of file +| `Tools` | [][components.AdvisorNestedTool](../../models/components/advisornestedtool) | :heavy_minus_sign: | Tools the advisor sub-agent may use while forming its advice. The advisor runs as an agentic sub-agent over these tools, then returns its text. Only OpenRouter server tools are supported — function tools are rejected — and the list must not include the advisor tool itself. | | \ No newline at end of file diff --git a/docs/models/components/advisorservertoolopenrouter.mdx b/docs/models/components/advisorservertoolopenrouter.mdx index 8ecadf19..9416435c 100644 --- a/docs/models/components/advisorservertoolopenrouter.mdx +++ b/docs/models/components/advisorservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: consults a higher-intelligence advisor model (a | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.AdvisorServerToolConfig](../../models/components/advisorservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | -| `Type` | [components.AdvisorServerToolOpenRouterType](../../models/components/advisorservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.AdvisorServerToolConfig](../../models/components/advisorservertoolconfig) | :heavy_minus_sign: | Configuration for one openrouter:advisor server tool entry. | \{
"model": "~anthropic/claude-opus-latest",
"name": "reviewer"
} | +| `Type` | [components.AdvisorServerToolOpenRouterType](../../models/components/advisorservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/agentmessageitem.mdx b/docs/models/components/agentmessageitem.mdx index a11f5189..1bb53028 100644 --- a/docs/models/components/agentmessageitem.mdx +++ b/docs/models/components/agentmessageitem.mdx @@ -9,10 +9,10 @@ A message routed between agents in a multi-agent session | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `Agent` | optionalnullable.OptionalNullable[[components.Agent](../../models/components/agent.mdx)] | :heavy_minus_sign: | N/A | | +| `Agent` | optionalnullable.OptionalNullable[[components.Agent](../../models/components/agent)] | :heavy_minus_sign: | N/A | | | `Author` | `string` | :heavy_check_mark: | N/A | | -| `Content` | [][components.AgentMessageItemContentUnion](../../models/components/agentmessageitemcontentunion.mdx) | :heavy_check_mark: | N/A | | +| `Content` | [][components.AgentMessageItemContentUnion](../../models/components/agentmessageitemcontentunion) | :heavy_check_mark: | N/A | | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `Recipient` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeAgentMessage](../../models/components/typeagentmessage.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeAgentMessage](../../models/components/typeagentmessage) | :heavy_check_mark: | N/A | | | `AdditionalProperties` | map[string]`any` | :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 diff --git a/docs/models/components/agentmessageitemcontentinputimage.mdx b/docs/models/components/agentmessageitemcontentinputimage.mdx index 0a5b029e..b58c6d0b 100644 --- a/docs/models/components/agentmessageitemcontentinputimage.mdx +++ b/docs/models/components/agentmessageitemcontentinputimage.mdx @@ -9,6 +9,6 @@ Image input content item | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.AgentMessageItemDetail](../../models/components/agentmessageitemdetail.mdx) | :heavy_check_mark: | N/A | +| `Detail` | [components.AgentMessageItemDetail](../../models/components/agentmessageitemdetail) | :heavy_check_mark: | N/A | | `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.AgentMessageItemTypeInputImage](../../models/components/agentmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AgentMessageItemTypeInputImage](../../models/components/agentmessageitemtypeinputimage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/annotationaddedevent.mdx b/docs/models/components/annotationaddedevent.mdx index d7a722dc..614d45cd 100644 --- a/docs/models/components/annotationaddedevent.mdx +++ b/docs/models/components/annotationaddedevent.mdx @@ -9,10 +9,10 @@ Event emitted when a text annotation is added to output | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `Annotation` | [components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | :heavy_check_mark: | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | +| `Annotation` | [components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation) | :heavy_check_mark: | N/A | \{
"file_id": "file-abc123",
"filename": "research_paper.pdf",
"index": 0,
"type": "file_citation"
} | | `AnnotationIndex` | `int64` | :heavy_check_mark: | N/A | | | `ContentIndex` | `int64` | :heavy_check_mark: | N/A | | | `ItemID` | `string` | :heavy_check_mark: | N/A | | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnnotationAddedEventType](../../models/components/annotationaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.AnnotationAddedEventType](../../models/components/annotationaddedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicadvisormessageusageiteration.mdx b/docs/models/components/anthropicadvisormessageusageiteration.mdx index ee2480e1..cfbfddd8 100644 --- a/docs/models/components/anthropicadvisormessageusageiteration.mdx +++ b/docs/models/components/anthropicadvisormessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicAdvisorMessageUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | | `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `Model` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicAdvisorMessageUsageIterationType](../../models/components/anthropicadvisormessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.AnthropicAdvisorMessageUsageIterationType](../../models/components/anthropicadvisormessageusageiterationtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicbase64imagesource.mdx b/docs/models/components/anthropicbase64imagesource.mdx index b97e64b9..b70bfd3a 100644 --- a/docs/models/components/anthropicbase64imagesource.mdx +++ b/docs/models/components/anthropicbase64imagesource.mdx @@ -7,5 +7,5 @@ title: "AnthropicBase64ImageSource" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `Data` | `string` | :heavy_check_mark: | N/A | | -| `MediaType` | [components.AnthropicImageMimeType](../../models/components/anthropicimagemimetype.mdx) | :heavy_check_mark: | N/A | image/jpeg | -| `Type` | [components.AnthropicBase64ImageSourceType](../../models/components/anthropicbase64imagesourcetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `MediaType` | [components.AnthropicImageMimeType](../../models/components/anthropicimagemimetype) | :heavy_check_mark: | N/A | image/jpeg | +| `Type` | [components.AnthropicBase64ImageSourceType](../../models/components/anthropicbase64imagesourcetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicbase64pdfsource.mdx b/docs/models/components/anthropicbase64pdfsource.mdx index 85776a1e..bf075e23 100644 --- a/docs/models/components/anthropicbase64pdfsource.mdx +++ b/docs/models/components/anthropicbase64pdfsource.mdx @@ -7,5 +7,5 @@ title: "AnthropicBase64PdfSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `Data` | `string` | :heavy_check_mark: | N/A | -| `MediaType` | [components.AnthropicBase64PdfSourceMediaType](../../models/components/anthropicbase64pdfsourcemediatype.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicBase64PdfSourceType](../../models/components/anthropicbase64pdfsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `MediaType` | [components.AnthropicBase64PdfSourceMediaType](../../models/components/anthropicbase64pdfsourcemediatype) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicBase64PdfSourceType](../../models/components/anthropicbase64pdfsourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccachecontroldirective.mdx b/docs/models/components/anthropiccachecontroldirective.mdx index ef3026af..b2d4ab93 100644 --- a/docs/models/components/anthropiccachecontroldirective.mdx +++ b/docs/models/components/anthropiccachecontroldirective.mdx @@ -9,5 +9,5 @@ Enable automatic prompt caching. When set at the top level, the system automatic | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `Type` | [components.AnthropicCacheControlDirectiveType](../../models/components/anthropiccachecontroldirectivetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | +| `Type` | [components.AnthropicCacheControlDirectiveType](../../models/components/anthropiccachecontroldirectivetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcharlocationparam.mdx b/docs/models/components/anthropiccitationcharlocationparam.mdx index 98984ed1..89c913fe 100644 --- a/docs/models/components/anthropiccitationcharlocationparam.mdx +++ b/docs/models/components/anthropiccitationcharlocationparam.mdx @@ -11,4 +11,4 @@ title: "AnthropicCitationCharLocationParam" | `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | | `EndCharIndex` | `int64` | :heavy_check_mark: | N/A | | `StartCharIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationCharLocationParamType](../../models/components/anthropiccitationcharlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicCitationCharLocationParamType](../../models/components/anthropiccitationcharlocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationcontentblocklocationparam.mdx b/docs/models/components/anthropiccitationcontentblocklocationparam.mdx index 76be2e87..63414ddd 100644 --- a/docs/models/components/anthropiccitationcontentblocklocationparam.mdx +++ b/docs/models/components/anthropiccitationcontentblocklocationparam.mdx @@ -11,4 +11,4 @@ title: "AnthropicCitationContentBlockLocationParam" | `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | | `EndBlockIndex` | `int64` | :heavy_check_mark: | N/A | | `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationContentBlockLocationParamType](../../models/components/anthropiccitationcontentblocklocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicCitationContentBlockLocationParamType](../../models/components/anthropiccitationcontentblocklocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationpagelocationparam.mdx b/docs/models/components/anthropiccitationpagelocationparam.mdx index aa8bcb3c..da68ec24 100644 --- a/docs/models/components/anthropiccitationpagelocationparam.mdx +++ b/docs/models/components/anthropiccitationpagelocationparam.mdx @@ -11,4 +11,4 @@ title: "AnthropicCitationPageLocationParam" | `DocumentTitle` | `*string` | :heavy_check_mark: | N/A | | `EndPageNumber` | `int64` | :heavy_check_mark: | N/A | | `StartPageNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationPageLocationParamType](../../models/components/anthropiccitationpagelocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicCitationPageLocationParamType](../../models/components/anthropiccitationpagelocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationsearchresultlocationparam.mdx b/docs/models/components/anthropiccitationsearchresultlocationparam.mdx index 05ae1113..86aa4925 100644 --- a/docs/models/components/anthropiccitationsearchresultlocationparam.mdx +++ b/docs/models/components/anthropiccitationsearchresultlocationparam.mdx @@ -12,4 +12,4 @@ title: "AnthropicCitationSearchResultLocationParam" | `Source` | `string` | :heavy_check_mark: | N/A | | `StartBlockIndex` | `int64` | :heavy_check_mark: | N/A | | `Title` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationSearchResultLocationParamType](../../models/components/anthropiccitationsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicCitationSearchResultLocationParamType](../../models/components/anthropiccitationsearchresultlocationparamtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx b/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx index cb799487..9d43db59 100644 --- a/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx +++ b/docs/models/components/anthropiccitationwebsearchresultlocationparam.mdx @@ -9,5 +9,5 @@ title: "AnthropicCitationWebSearchResultLocationParam" | `CitedText` | `string` | :heavy_check_mark: | N/A | | `EncryptedIndex` | `string` | :heavy_check_mark: | N/A | | `Title` | `*string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicCitationWebSearchResultLocationParamType](../../models/components/anthropiccitationwebsearchresultlocationparamtype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicCitationWebSearchResultLocationParamType](../../models/components/anthropiccitationwebsearchresultlocationparamtype) | :heavy_check_mark: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropiccompactionusageiteration.mdx b/docs/models/components/anthropiccompactionusageiteration.mdx index dd4c8965..ea0d9fd1 100644 --- a/docs/models/components/anthropiccompactionusageiteration.mdx +++ b/docs/models/components/anthropiccompactionusageiteration.mdx @@ -6,9 +6,9 @@ title: "AnthropicCompactionUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | | `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | -| `Type` | [components.AnthropicCompactionUsageIterationType](../../models/components/anthropiccompactionusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.AnthropicCompactionUsageIterationType](../../models/components/anthropiccompactionusageiterationtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicdocumentblockparam.mdx b/docs/models/components/anthropicdocumentblockparam.mdx index 58220504..23f3a4f2 100644 --- a/docs/models/components/anthropicdocumentblockparam.mdx +++ b/docs/models/components/anthropicdocumentblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicDocumentBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | optionalnullable.OptionalNullable[[components.AnthropicDocumentBlockParamCitations](../../models/components/anthropicdocumentblockparamcitations.mdx)] | :heavy_minus_sign: | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | optionalnullable.OptionalNullable[[components.AnthropicDocumentBlockParamCitations](../../models/components/anthropicdocumentblockparamcitations)] | :heavy_minus_sign: | N/A | | | `Context` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Source` | [components.AnthropicDocumentBlockParamSourceUnion](../../models/components/anthropicdocumentblockparamsourceunion.mdx) | :heavy_check_mark: | N/A | | +| `Source` | [components.AnthropicDocumentBlockParamSourceUnion](../../models/components/anthropicdocumentblockparamsourceunion) | :heavy_check_mark: | N/A | | | `Title` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.TypeDocument](../../models/components/typedocument.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.TypeDocument](../../models/components/typedocument) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicfile.mdx b/docs/models/components/anthropicfile.mdx index df8cc5a0..5050a438 100644 --- a/docs/models/components/anthropicfile.mdx +++ b/docs/models/components/anthropicfile.mdx @@ -9,11 +9,11 @@ A stored file in Anthropic's Files API shape. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Shape` | [components.AnthropicFileShape](../../models/components/anthropicfileshape.mdx) | :heavy_check_mark: | N/A | +| `Shape` | [components.AnthropicFileShape](../../models/components/anthropicfileshape) | :heavy_check_mark: | N/A | | `CreatedAt` | `string` | :heavy_check_mark: | N/A | | `Downloadable` | `bool` | :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` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicFileType](../../models/components/anthropicfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicFileType](../../models/components/anthropicfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfiledeleted.mdx b/docs/models/components/anthropicfiledeleted.mdx index e6252729..af67f8ff 100644 --- a/docs/models/components/anthropicfiledeleted.mdx +++ b/docs/models/components/anthropicfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in Anthropic's shape. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Shape` | [components.AnthropicFileDeletedShape](../../models/components/anthropicfiledeletedshape.mdx) | :heavy_check_mark: | N/A | +| `Shape` | [components.AnthropicFileDeletedShape](../../models/components/anthropicfiledeletedshape) | :heavy_check_mark: | N/A | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicFileDeletedType](../../models/components/anthropicfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicFileDeletedType](../../models/components/anthropicfiledeletedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfiledocumentsource.mdx b/docs/models/components/anthropicfiledocumentsource.mdx index 232e3fd8..83d08434 100644 --- a/docs/models/components/anthropicfiledocumentsource.mdx +++ b/docs/models/components/anthropicfiledocumentsource.mdx @@ -7,4 +7,4 @@ title: "AnthropicFileDocumentSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | `FileID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicFileDocumentSourceType](../../models/components/anthropicfiledocumentsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicFileDocumentSourceType](../../models/components/anthropicfiledocumentsourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicfilelist.mdx b/docs/models/components/anthropicfilelist.mdx index f8c77f70..39682df8 100644 --- a/docs/models/components/anthropicfilelist.mdx +++ b/docs/models/components/anthropicfilelist.mdx @@ -9,8 +9,8 @@ A page of files in Anthropic's shape. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Shape` | [components.AnthropicFileListShape](../../models/components/anthropicfilelistshape.mdx) | :heavy_check_mark: | N/A | -| `Data` | [][components.AnthropicFile](../../models/components/anthropicfile.mdx) | :heavy_check_mark: | N/A | +| `Shape` | [components.AnthropicFileListShape](../../models/components/anthropicfilelistshape) | :heavy_check_mark: | N/A | +| `Data` | [][components.AnthropicFile](../../models/components/anthropicfile) | :heavy_check_mark: | N/A | | `FirstID` | `*string` | :heavy_check_mark: | N/A | | `HasMore` | `bool` | :heavy_check_mark: | N/A | | `LastID` | `*string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicimageblockparam.mdx b/docs/models/components/anthropicimageblockparam.mdx index 55384b6a..a1fde81b 100644 --- a/docs/models/components/anthropicimageblockparam.mdx +++ b/docs/models/components/anthropicimageblockparam.mdx @@ -6,6 +6,6 @@ title: "AnthropicImageBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [components.AnthropicImageBlockParamSource](../../models/components/anthropicimageblockparamsource.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicImageBlockParamType](../../models/components/anthropicimageblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [components.AnthropicImageBlockParamSource](../../models/components/anthropicimageblockparamsource) | :heavy_check_mark: | N/A | | +| `Type` | [components.AnthropicImageBlockParamType](../../models/components/anthropicimageblockparamtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicinputtokensclearatleast.mdx b/docs/models/components/anthropicinputtokensclearatleast.mdx index 4f070567..14c9ebbc 100644 --- a/docs/models/components/anthropicinputtokensclearatleast.mdx +++ b/docs/models/components/anthropicinputtokensclearatleast.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensClearAtLeast" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.AnthropicInputTokensClearAtLeastType](../../models/components/anthropicinputtokensclearatleasttype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicInputTokensClearAtLeastType](../../models/components/anthropicinputtokensclearatleasttype) | :heavy_check_mark: | N/A | | `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicinputtokenstrigger.mdx b/docs/models/components/anthropicinputtokenstrigger.mdx index 30868cc6..c5ee6064 100644 --- a/docs/models/components/anthropicinputtokenstrigger.mdx +++ b/docs/models/components/anthropicinputtokenstrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicInputTokensTrigger" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicInputTokensTriggerType](../../models/components/anthropicinputtokenstriggertype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicInputTokensTriggerType](../../models/components/anthropicinputtokenstriggertype) | :heavy_check_mark: | N/A | | `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicmessageusageiteration.mdx b/docs/models/components/anthropicmessageusageiteration.mdx index 7def3586..6fe41199 100644 --- a/docs/models/components/anthropicmessageusageiteration.mdx +++ b/docs/models/components/anthropicmessageusageiteration.mdx @@ -6,10 +6,10 @@ title: "AnthropicMessageUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | | `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `OutputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `Model` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.AnthropicMessageUsageIterationType](../../models/components/anthropicmessageusageiterationtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.AnthropicMessageUsageIterationType](../../models/components/anthropicmessageusageiterationtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicplaintextsource.mdx b/docs/models/components/anthropicplaintextsource.mdx index 0f8ee421..24766f82 100644 --- a/docs/models/components/anthropicplaintextsource.mdx +++ b/docs/models/components/anthropicplaintextsource.mdx @@ -7,5 +7,5 @@ title: "AnthropicPlainTextSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `Data` | `string` | :heavy_check_mark: | N/A | -| `MediaType` | [components.AnthropicPlainTextSourceMediaType](../../models/components/anthropicplaintextsourcemediatype.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicPlainTextSourceType](../../models/components/anthropicplaintextsourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `MediaType` | [components.AnthropicPlainTextSourceMediaType](../../models/components/anthropicplaintextsourcemediatype) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicPlainTextSourceType](../../models/components/anthropicplaintextsourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicsearchresultblockparam.mdx b/docs/models/components/anthropicsearchresultblockparam.mdx index 8cfe7f42..afb9deab 100644 --- a/docs/models/components/anthropicsearchresultblockparam.mdx +++ b/docs/models/components/anthropicsearchresultblockparam.mdx @@ -6,9 +6,9 @@ title: "AnthropicSearchResultBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [*components.AnthropicSearchResultBlockParamCitations](../../models/components/anthropicsearchresultblockparamcitations.mdx) | :heavy_minus_sign: | N/A | | -| `Content` | [][components.AnthropicTextBlockParam](../../models/components/anthropictextblockparam.mdx) | :heavy_check_mark: | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [*components.AnthropicSearchResultBlockParamCitations](../../models/components/anthropicsearchresultblockparamcitations) | :heavy_minus_sign: | N/A | | +| `Content` | [][components.AnthropicTextBlockParam](../../models/components/anthropictextblockparam) | :heavy_check_mark: | N/A | | | `Source` | `string` | :heavy_check_mark: | N/A | | | `Title` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicSearchResultBlockParamType](../../models/components/anthropicsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.AnthropicSearchResultBlockParamType](../../models/components/anthropicsearchresultblockparamtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictextblockparam.mdx b/docs/models/components/anthropictextblockparam.mdx index 7bc465ce..a8fb3b15 100644 --- a/docs/models/components/anthropictextblockparam.mdx +++ b/docs/models/components/anthropictextblockparam.mdx @@ -6,7 +6,7 @@ title: "AnthropicTextBlockParam" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | optionalnullable.OptionalNullable[[][components.Citation](../../models/components/citation.mdx)] | :heavy_minus_sign: | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | optionalnullable.OptionalNullable[[][components.Citation](../../models/components/citation)] | :heavy_minus_sign: | N/A | | | `Text` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.AnthropicTextBlockParamType](../../models/components/anthropictextblockparamtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.AnthropicTextBlockParamType](../../models/components/anthropictextblockparamtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropicthinkingturns.mdx b/docs/models/components/anthropicthinkingturns.mdx index 81a62980..39d9e3a8 100644 --- a/docs/models/components/anthropicthinkingturns.mdx +++ b/docs/models/components/anthropicthinkingturns.mdx @@ -6,5 +6,5 @@ title: "AnthropicThinkingTurns" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicThinkingTurnsType](../../models/components/anthropicthinkingturnstype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicThinkingTurnsType](../../models/components/anthropicthinkingturnstype) | :heavy_check_mark: | N/A | | `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchtoolbm25.mdx b/docs/models/components/anthropictoolsearchtoolbm25.mdx index a9c53b68..bed3277c 100644 --- a/docs/models/components/anthropictoolsearchtoolbm25.mdx +++ b/docs/models/components/anthropictoolsearchtoolbm25.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolBm25" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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"
} | +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers) | :heavy_minus_sign: | N/A | [
"direct"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | `*bool` | :heavy_minus_sign: | N/A | | -| `Name` | [components.AnthropicToolSearchToolBm25Name](../../models/components/anthropictoolsearchtoolbm25name.mdx) | :heavy_check_mark: | N/A | | +| `Name` | [components.AnthropicToolSearchToolBm25Name](../../models/components/anthropictoolsearchtoolbm25name) | :heavy_check_mark: | N/A | | | `Strict` | `*bool` | :heavy_minus_sign: | N/A | | -| `Type` | [components.AnthropicToolSearchToolBm25Type](../../models/components/anthropictoolsearchtoolbm25type.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.AnthropicToolSearchToolBm25Type](../../models/components/anthropictoolsearchtoolbm25type) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictoolsearchtoolregex.mdx b/docs/models/components/anthropictoolsearchtoolregex.mdx index 7955aafd..ed69df34 100644 --- a/docs/models/components/anthropictoolsearchtoolregex.mdx +++ b/docs/models/components/anthropictoolsearchtoolregex.mdx @@ -6,9 +6,9 @@ title: "AnthropicToolSearchToolRegex" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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"
} | +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers) | :heavy_minus_sign: | N/A | [
"direct"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | `*bool` | :heavy_minus_sign: | N/A | | -| `Name` | [components.AnthropicToolSearchToolRegexName](../../models/components/anthropictoolsearchtoolregexname.mdx) | :heavy_check_mark: | N/A | | +| `Name` | [components.AnthropicToolSearchToolRegexName](../../models/components/anthropictoolsearchtoolregexname) | :heavy_check_mark: | N/A | | | `Strict` | `*bool` | :heavy_minus_sign: | N/A | | -| `Type` | [components.AnthropicToolSearchToolRegexType](../../models/components/anthropictoolsearchtoolregextype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.AnthropicToolSearchToolRegexType](../../models/components/anthropictoolsearchtoolregextype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/anthropictooluseskeep.mdx b/docs/models/components/anthropictooluseskeep.mdx index aa7dcff6..438207bc 100644 --- a/docs/models/components/anthropictooluseskeep.mdx +++ b/docs/models/components/anthropictooluseskeep.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesKeep" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicToolUsesKeepType](../../models/components/anthropictooluseskeeptype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicToolUsesKeepType](../../models/components/anthropictooluseskeeptype) | :heavy_check_mark: | N/A | | `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropictoolusestrigger.mdx b/docs/models/components/anthropictoolusestrigger.mdx index 5c288271..fef4e427 100644 --- a/docs/models/components/anthropictoolusestrigger.mdx +++ b/docs/models/components/anthropictoolusestrigger.mdx @@ -6,5 +6,5 @@ title: "AnthropicToolUsesTrigger" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicToolUsesTriggerType](../../models/components/anthropictoolusestriggertype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicToolUsesTriggerType](../../models/components/anthropictoolusestriggertype) | :heavy_check_mark: | N/A | | `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicunknownusageiteration.mdx b/docs/models/components/anthropicunknownusageiteration.mdx index bbe04bc1..e088823c 100644 --- a/docs/models/components/anthropicunknownusageiteration.mdx +++ b/docs/models/components/anthropicunknownusageiteration.mdx @@ -6,7 +6,7 @@ title: "AnthropicUnknownUsageIteration" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicIterationCacheCreation](../../models/components/anthropiciterationcachecreation)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 0
} | | `CacheCreationInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `CacheReadInputTokens` | `*int64` | :heavy_minus_sign: | N/A | | | `InputTokens` | `*int64` | :heavy_minus_sign: | N/A | | diff --git a/docs/models/components/anthropicurlimagesource.mdx b/docs/models/components/anthropicurlimagesource.mdx index 6c06a380..c10615f7 100644 --- a/docs/models/components/anthropicurlimagesource.mdx +++ b/docs/models/components/anthropicurlimagesource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLImageSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Type` | [components.AnthropicURLImageSourceType](../../models/components/anthropicurlimagesourcetype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicURLImageSourceType](../../models/components/anthropicurlimagesourcetype) | :heavy_check_mark: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicurlpdfsource.mdx b/docs/models/components/anthropicurlpdfsource.mdx index 20ac4142..b3bb0437 100644 --- a/docs/models/components/anthropicurlpdfsource.mdx +++ b/docs/models/components/anthropicurlpdfsource.mdx @@ -6,5 +6,5 @@ title: "AnthropicURLPdfSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Type` | [components.AnthropicURLPdfSourceType](../../models/components/anthropicurlpdfsourcetype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicURLPdfSourceType](../../models/components/anthropicurlpdfsourcetype) | :heavy_check_mark: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchresultblockparam.mdx b/docs/models/components/anthropicwebsearchresultblockparam.mdx index eb657420..1826059f 100644 --- a/docs/models/components/anthropicwebsearchresultblockparam.mdx +++ b/docs/models/components/anthropicwebsearchresultblockparam.mdx @@ -9,5 +9,5 @@ title: "AnthropicWebSearchResultBlockParam" | `EncryptedContent` | `string` | :heavy_check_mark: | N/A | | `PageAge` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Title` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.AnthropicWebSearchResultBlockParamType](../../models/components/anthropicwebsearchresultblockparamtype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.AnthropicWebSearchResultBlockParamType](../../models/components/anthropicwebsearchresultblockparamtype) | :heavy_check_mark: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/anthropicwebsearchtooluserlocation.mdx b/docs/models/components/anthropicwebsearchtooluserlocation.mdx index d4d13b47..d51fc6ac 100644 --- a/docs/models/components/anthropicwebsearchtooluserlocation.mdx +++ b/docs/models/components/anthropicwebsearchtooluserlocation.mdx @@ -10,4 +10,4 @@ title: "AnthropicWebSearchToolUserLocation" | `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.AnthropicWebSearchToolUserLocationType](../../models/components/anthropicwebsearchtooluserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.AnthropicWebSearchToolUserLocationType](../../models/components/anthropicwebsearchtooluserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcallitem.mdx b/docs/models/components/applypatchcallitem.mdx index e4cf696e..0e781ea1 100644 --- a/docs/models/components/applypatchcallitem.mdx +++ b/docs/models/components/applypatchcallitem.mdx @@ -11,6 +11,6 @@ A tool call emitted by the model requesting a V4A patch operation. The client ap | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `CallID` | `string` | :heavy_check_mark: | N/A | | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | :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` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `Type` | [components.ApplyPatchCallItemType](../../models/components/applypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Operation` | [components.ApplyPatchCallOperation](../../models/components/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` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | +| `Type` | [components.ApplyPatchCallItemType](../../models/components/applypatchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx b/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx index 6d90864a..07f94d1b 100644 --- a/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx +++ b/docs/models/components/applypatchcalloperationdiffdeltaevent.mdx @@ -13,4 +13,4 @@ Incremental chunk of `operation.diff` for an `apply_patch_call`. Matches OpenAI' | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../../models/components/applypatchcalloperationdiffdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ApplyPatchCallOperationDiffDeltaEventType](../../models/components/applypatchcalloperationdiffdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcalloperationdiffdoneevent.mdx b/docs/models/components/applypatchcalloperationdiffdoneevent.mdx index eded2af5..e22c77f4 100644 --- a/docs/models/components/applypatchcalloperationdiffdoneevent.mdx +++ b/docs/models/components/applypatchcalloperationdiffdoneevent.mdx @@ -13,4 +13,4 @@ Emitted when `operation.diff` streaming completes for an `apply_patch_call`. | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCallOperationDiffDoneEventType](../../models/components/applypatchcalloperationdiffdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ApplyPatchCallOperationDiffDoneEventType](../../models/components/applypatchcalloperationdiffdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcalloutputitem.mdx b/docs/models/components/applypatchcalloutputitem.mdx index e52266b8..ce9721f7 100644 --- a/docs/models/components/applypatchcalloutputitem.mdx +++ b/docs/models/components/applypatchcalloutputitem.mdx @@ -12,5 +12,5 @@ The client's echo of an `apply_patch_call` after applying the patch. `output` is | `CallID` | `string` | :heavy_check_mark: | N/A | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Output` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Status` | [components.ApplyPatchCallOutputItemStatus](../../models/components/applypatchcalloutputitemstatus.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCallOutputItemType](../../models/components/applypatchcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Status` | [components.ApplyPatchCallOutputItemStatus](../../models/components/applypatchcalloutputitemstatus) | :heavy_check_mark: | N/A | +| `Type` | [components.ApplyPatchCallOutputItemType](../../models/components/applypatchcalloutputitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchcreatefileoperation.mdx b/docs/models/components/applypatchcreatefileoperation.mdx index 031da0c1..d3770fa1 100644 --- a/docs/models/components/applypatchcreatefileoperation.mdx +++ b/docs/models/components/applypatchcreatefileoperation.mdx @@ -11,4 +11,4 @@ The `create_file` variant of an `apply_patch_call.operation`. Carries a V4A diff | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `Diff` | `string` | :heavy_check_mark: | N/A | | `Path` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchCreateFileOperationType](../../models/components/applypatchcreatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ApplyPatchCreateFileOperationType](../../models/components/applypatchcreatefileoperationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchdeletefileoperation.mdx b/docs/models/components/applypatchdeletefileoperation.mdx index 96183321..4d4abb1b 100644 --- a/docs/models/components/applypatchdeletefileoperation.mdx +++ b/docs/models/components/applypatchdeletefileoperation.mdx @@ -10,4 +10,4 @@ The `delete_file` variant of an `apply_patch_call.operation`. Identifies the fil | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `Path` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchDeleteFileOperationType](../../models/components/applypatchdeletefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ApplyPatchDeleteFileOperationType](../../models/components/applypatchdeletefileoperationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchservertool.mdx b/docs/models/components/applypatchservertool.mdx index 7536b291..c54e69a2 100644 --- a/docs/models/components/applypatchservertool.mdx +++ b/docs/models/components/applypatchservertool.mdx @@ -9,4 +9,4 @@ Apply patch tool configuration | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Type` | [components.ApplyPatchServerToolType](../../models/components/applypatchservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ApplyPatchServerToolType](../../models/components/applypatchservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/applypatchservertoolconfig.mdx b/docs/models/components/applypatchservertoolconfig.mdx index 9f223f7f..2780d801 100644 --- a/docs/models/components/applypatchservertoolconfig.mdx +++ b/docs/models/components/applypatchservertoolconfig.mdx @@ -9,4 +9,4 @@ Configuration for the openrouter:apply_patch server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.ApplyPatchEngineEnum](../../models/components/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` | [*components.ApplyPatchEngineEnum](../../models/components/applypatchengineenum) | :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 diff --git a/docs/models/components/applypatchservertoolopenrouter.mdx b/docs/models/components/applypatchservertoolopenrouter.mdx index db392acd..f1249df6 100644 --- a/docs/models/components/applypatchservertoolopenrouter.mdx +++ b/docs/models/components/applypatchservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: validates V4A diff patches for file operations | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ApplyPatchServerToolConfig](../../models/components/applypatchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | -| `Type` | [components.ApplyPatchServerToolOpenRouterType](../../models/components/applypatchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.ApplyPatchServerToolConfig](../../models/components/applypatchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:apply_patch server tool | \{
"engine": "auto"
} | +| `Type` | [components.ApplyPatchServerToolOpenRouterType](../../models/components/applypatchservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/applypatchupdatefileoperation.mdx b/docs/models/components/applypatchupdatefileoperation.mdx index 33ff6f7b..dff9b119 100644 --- a/docs/models/components/applypatchupdatefileoperation.mdx +++ b/docs/models/components/applypatchupdatefileoperation.mdx @@ -11,4 +11,4 @@ The `update_file` variant of an `apply_patch_call.operation`. Carries a V4A diff | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `Diff` | `string` | :heavy_check_mark: | N/A | | `Path` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ApplyPatchUpdateFileOperationType](../../models/components/applypatchupdatefileoperationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ApplyPatchUpdateFileOperationType](../../models/components/applypatchupdatefileoperationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/apprankingsresponse.mdx b/docs/models/components/apprankingsresponse.mdx index 7faec742..a5866a8f 100644 --- a/docs/models/components/apprankingsresponse.mdx +++ b/docs/models/components/apprankingsresponse.mdx @@ -6,5 +6,5 @@ title: "AppRankingsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [][components.AppRankingsItem](../../models/components/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` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `Data` | [][components.AppRankingsItem](../../models/components/apprankingsitem) | :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` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/components/architecture.mdx b/docs/models/components/architecture.mdx index ced20cd9..ae5c2b60 100644 --- a/docs/models/components/architecture.mdx +++ b/docs/models/components/architecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | :heavy_check_mark: | Supported input modalities | | -| `InstructType` | [*components.InstructType](../../models/components/instructtype.mdx) | :heavy_check_mark: | Instruction format type | chatml | +| `InputModalities` | [][components.InputModality](../../models/components/inputmodality) | :heavy_check_mark: | Supported input modalities | | +| `InstructType` | [*components.InstructType](../../models/components/instructtype) | :heavy_check_mark: | Instruction format type | chatml | | `Modality` | `*string` | :heavy_check_mark: | Primary modality of the model | text | -| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | :heavy_check_mark: | Supported output modalities | | -| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file +| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality) | :heavy_check_mark: | Supported output modalities | | +| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup) | :heavy_check_mark: | N/A | GPT | \ No newline at end of file diff --git a/docs/models/components/autobetarouterplugin.mdx b/docs/models/components/autobetarouterplugin.mdx index 97673090..7e2f8e72 100644 --- a/docs/models/components/autobetarouterplugin.mdx +++ b/docs/models/components/autobetarouterplugin.mdx @@ -8,6 +8,6 @@ title: "AutoBetaRouterPlugin" | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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). When not specified, uses the default supported models list. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | | ~~`CostQualityTradeoff`~~ | `*int64` | :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. Numeric cost_quality_tradeoff remains supported, retains ceiling behavior, and takes precedence over cost_tier when both are provided. | 9 | -| `CostTier` | [*components.AutoBetaRouterPluginCostTier](../../models/components/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]. Numeric cost_quality_tradeoff takes precedence and retains ceiling behavior. | low | +| `CostTier` | [*components.AutoBetaRouterPluginCostTier](../../models/components/autobetarouterplugincosttier) | :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]. Numeric cost_quality_tradeoff takes precedence and retains ceiling behavior. | low | | `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the auto-beta-router plugin for this request. Defaults to true. | | -| `ID` | [components.AutoBetaRouterPluginID](../../models/components/autobetarouterpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `ID` | [components.AutoBetaRouterPluginID](../../models/components/autobetarouterpluginid) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/autorouterplugin.mdx b/docs/models/components/autorouterplugin.mdx index a073c274..e622c455 100644 --- a/docs/models/components/autorouterplugin.mdx +++ b/docs/models/components/autorouterplugin.mdx @@ -8,7 +8,7 @@ title: "AutoRouterPlugin" | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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). When not specified, uses the default supported models list. | [
"anthropic/*",
"openai/gpt-4o",
"google/*"
] | | ~~`CostQualityTradeoff`~~ | `*int64` | :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. Controls cost vs. quality routing tradeoff (0–10). 0 = pure quality (best model regardless of cost), 10 = maximize for cost (cheapest model wins). Intermediate values blend quality and cost signals continuously. Defaults to 7. Numeric cost_quality_tradeoff remains supported and takes precedence over cost_tier when both are provided. | 7 | -| `CostTier` | [*components.AutoRouterPluginCostTier](../../models/components/autorouterplugincosttier.mdx) | :heavy_minus_sign: | Shorthand for cost_quality_tradeoff. Higher tiers spend more on better models: low = 9, medium = 7, high = 5, xhigh = 3, and max = 1. Numeric cost_quality_tradeoff takes precedence when both are provided. | medium | +| `CostTier` | [*components.AutoRouterPluginCostTier](../../models/components/autorouterplugincosttier) | :heavy_minus_sign: | Shorthand for cost_quality_tradeoff. Higher tiers spend more on better models: low = 9, medium = 7, high = 5, xhigh = 3, and max = 1. Numeric cost_quality_tradeoff takes precedence when both are provided. | medium | | `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the auto-router plugin for this request. Defaults to true. | | -| `ID` | [components.AutoRouterPluginID](../../models/components/autorouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `ID` | [components.AutoRouterPluginID](../../models/components/autorouterpluginid) | :heavy_check_mark: | N/A | | | `PinModel` | `*bool` | :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 diff --git a/docs/models/components/baseinputsmessage.mdx b/docs/models/components/baseinputsmessage.mdx index 66d25c30..5a1a694b 100644 --- a/docs/models/components/baseinputsmessage.mdx +++ b/docs/models/components/baseinputsmessage.mdx @@ -6,7 +6,7 @@ title: "BaseInputsMessage" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.BaseInputsContent2](../../models/components/baseinputscontent2.mdx) | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.BaseInputsPhaseUnion](../../models/components/baseinputsphaseunion.mdx)] | :heavy_minus_sign: | N/A | -| `Role` | [components.BaseInputsRoleUnion](../../models/components/baseinputsroleunion.mdx) | :heavy_check_mark: | N/A | -| `Type` | [*components.BaseInputsType](../../models/components/baseinputstype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Content` | [components.BaseInputsContent2](../../models/components/baseinputscontent2) | :heavy_check_mark: | N/A | +| `Phase` | optionalnullable.OptionalNullable[[components.BaseInputsPhaseUnion](../../models/components/baseinputsphaseunion)] | :heavy_minus_sign: | N/A | +| `Role` | [components.BaseInputsRoleUnion](../../models/components/baseinputsroleunion) | :heavy_check_mark: | N/A | +| `Type` | [*components.BaseInputsType](../../models/components/baseinputstype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/basereasoningconfig.mdx b/docs/models/components/basereasoningconfig.mdx index 7c6464ad..3a074c78 100644 --- a/docs/models/components/basereasoningconfig.mdx +++ b/docs/models/components/basereasoningconfig.mdx @@ -6,7 +6,7 @@ title: "BaseReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/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` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | :heavy_minus_sign: | N/A | medium | -| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/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` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | :heavy_minus_sign: | N/A | auto | \ No newline at end of file +| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext)] | :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` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort)] | :heavy_minus_sign: | N/A | medium | +| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode)] | :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` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity)] | :heavy_minus_sign: | N/A | auto | \ No newline at end of file diff --git a/docs/models/components/bashservertool.mdx b/docs/models/components/bashservertool.mdx index 40ea034b..4ef5b340 100644 --- a/docs/models/components/bashservertool.mdx +++ b/docs/models/components/bashservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: runs shell commands server-side in a sandboxed | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `Parameters` | [*components.BashServerToolConfig](../../models/components/bashservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | -| `Type` | [components.BashServerToolType](../../models/components/bashservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.BashServerToolConfig](../../models/components/bashservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:bash server tool | \{
"environment": \{
"type": "container_auto"
}
} | +| `Type` | [components.BashServerToolType](../../models/components/bashservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/bashservertoolconfig.mdx b/docs/models/components/bashservertoolconfig.mdx index 736a5c7a..38a98a07 100644 --- a/docs/models/components/bashservertoolconfig.mdx +++ b/docs/models/components/bashservertoolconfig.mdx @@ -9,6 +9,6 @@ Configuration for the openrouter:bash server tool | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Engine` | [*components.BashServerToolEngine](../../models/components/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` | [*components.BashServerToolEnvironment](../../models/components/bashservertoolenvironment.mdx) | :heavy_minus_sign: | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | +| `Engine` | [*components.BashServerToolEngine](../../models/components/bashservertoolengine) | :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` | [*components.BashServerToolEnvironment](../../models/components/bashservertoolenvironment) | :heavy_minus_sign: | Execution environment for the bash server tool. | \{
"type": "container_auto"
} | | `SleepAfterSeconds` | `*int64` | :heavy_minus_sign: | How long (in seconds) the container stays warm after its last command before sleeping, freeing its capacity slot. Idle-based: each command renews the timer. Defaults to 900 (15 minutes); capped at 2592000 (30 days). | 900 | \ No newline at end of file diff --git a/docs/models/components/booleancapability.mdx b/docs/models/components/booleancapability.mdx index 3505ed8c..a32daec7 100644 --- a/docs/models/components/booleancapability.mdx +++ b/docs/models/components/booleancapability.mdx @@ -9,4 +9,4 @@ A supported-or-not flag. Present means the parameter is accepted. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Type` | [components.BooleanCapabilityType](../../models/components/booleancapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.BooleanCapabilityType](../../models/components/booleancapabilitytype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/bulkaddworkspacemembersresponse.mdx b/docs/models/components/bulkaddworkspacemembersresponse.mdx index a7b13193..ac81b96b 100644 --- a/docs/models/components/bulkaddworkspacemembersresponse.mdx +++ b/docs/models/components/bulkaddworkspacemembersresponse.mdx @@ -7,4 +7,4 @@ title: "BulkAddWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `AddedCount` | `int64` | :heavy_check_mark: | Number of workspace memberships created or updated | 2 | -| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file +| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember) | :heavy_check_mark: | List of added workspace memberships | | \ No newline at end of file diff --git a/docs/models/components/byokkey.mdx b/docs/models/components/byokkey.mdx index 7b60df30..047855a3 100644 --- a/docs/models/components/byokkey.mdx +++ b/docs/models/components/byokkey.mdx @@ -15,6 +15,6 @@ title: "BYOKKey" | `IsFallback` | `bool` | :heavy_check_mark: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | 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` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | | `SortOrder` | `int64` | :heavy_check_mark: | Position within the provider — credentials are tried in ascending sort order. | 0 | | `WorkspaceID` | `string` | :heavy_check_mark: | ID of the workspace this credential belongs to. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/chatassistantimages.mdx b/docs/models/components/chatassistantimages.mdx index fd6c5d75..f1bc52c5 100644 --- a/docs/models/components/chatassistantimages.mdx +++ b/docs/models/components/chatassistantimages.mdx @@ -6,4 +6,4 @@ title: "ChatAssistantImages" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ChatAssistantImagesImageURL](../../models/components/chatassistantimagesimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.ChatAssistantImagesImageURL](../../models/components/chatassistantimagesimageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatassistantmessage.mdx b/docs/models/components/chatassistantmessage.mdx index d41ea38d..58a67471 100644 --- a/docs/models/components/chatassistantmessage.mdx +++ b/docs/models/components/chatassistantmessage.mdx @@ -9,13 +9,13 @@ Assistant message for requests and responses | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Audio` | [*components.ChatAudioOutput](../../models/components/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` | optionalnullable.OptionalNullable[[components.ChatAssistantMessageContent](../../models/components/chatassistantmessagecontent.mdx)] | :heavy_minus_sign: | Assistant message content | | -| `Images` | [][components.ChatAssistantImages](../../models/components/chatassistantimages.mdx) | :heavy_minus_sign: | Generated images from image generation models | [
\{
"image_url": \{
"url": "data:image/png;base64,iVBORw0KGgo..."
}
}
] | +| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput) | :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` | optionalnullable.OptionalNullable[[components.ChatAssistantMessageContent](../../models/components/chatassistantmessagecontent)] | :heavy_minus_sign: | Assistant message content | | +| `Images` | [][components.ChatAssistantImages](../../models/components/chatassistantimages) | :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` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Reasoning output | | -| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | +| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me work through this step by step...",
"type": "reasoning.text"
}
] | | `Refusal` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Refusal message if content was refused | | -| `Role` | [components.ChatAssistantMessageRole](../../models/components/chatassistantmessagerole.mdx) | :heavy_check_mark: | N/A | | -| `ToolCalls` | [][components.ChatToolCall](../../models/components/chattoolcall.mdx) | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file +| `Role` | [components.ChatAssistantMessageRole](../../models/components/chatassistantmessagerole) | :heavy_check_mark: | N/A | | +| `ToolCalls` | [][components.ChatToolCall](../../models/components/chattoolcall) | :heavy_minus_sign: | Tool calls made by the assistant | | \ No newline at end of file diff --git a/docs/models/components/chatchoice.mdx b/docs/models/components/chatchoice.mdx index 9c7ef7a8..bed8d849 100644 --- a/docs/models/components/chatchoice.mdx +++ b/docs/models/components/chatchoice.mdx @@ -9,7 +9,7 @@ Chat completion choice | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | +| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum) | :heavy_check_mark: | N/A | stop | | `Index` | `int64` | :heavy_check_mark: | Choice index | 0 | -| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs.mdx)] | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | -| `Message` | [components.ChatAssistantMessage](../../models/components/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 +| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs)] | :heavy_minus_sign: | Log probabilities for the completion | \{
"content": [
\{
"bytes": null,
"logprob": -0.612345,
"token": " Hello",
"top_logprobs": []
}
],
"refusal": null
} | +| `Message` | [components.ChatAssistantMessage](../../models/components/chatassistantmessage) | :heavy_check_mark: | 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/components/chatcontentaudio.mdx b/docs/models/components/chatcontentaudio.mdx index 2b015706..786e9740 100644 --- a/docs/models/components/chatcontentaudio.mdx +++ b/docs/models/components/chatcontentaudio.mdx @@ -9,5 +9,5 @@ Audio input content part. Supported audio formats vary by provider. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `InputAudio` | [components.ChatContentAudioInputAudio](../../models/components/chatcontentaudioinputaudio.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatContentAudioType](../../models/components/chatcontentaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `InputAudio` | [components.ChatContentAudioInputAudio](../../models/components/chatcontentaudioinputaudio) | :heavy_check_mark: | N/A | +| `Type` | [components.ChatContentAudioType](../../models/components/chatcontentaudiotype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatcontentcachecontrol.mdx b/docs/models/components/chatcontentcachecontrol.mdx index 110129bb..f29f5302 100644 --- a/docs/models/components/chatcontentcachecontrol.mdx +++ b/docs/models/components/chatcontentcachecontrol.mdx @@ -9,5 +9,5 @@ Anthropic-style cache breakpoint for the content part. Interchangeable with the | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl.mdx) | :heavy_minus_sign: | N/A | 5m | -| `Type` | [components.ChatContentCacheControlType](../../models/components/chatcontentcachecontroltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `TTL` | [*components.AnthropicCacheControlTTL](../../models/components/anthropiccachecontrolttl) | :heavy_minus_sign: | N/A | 5m | +| `Type` | [components.ChatContentCacheControlType](../../models/components/chatcontentcachecontroltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatcontentfile.mdx b/docs/models/components/chatcontentfile.mdx index 45398aeb..66674b34 100644 --- a/docs/models/components/chatcontentfile.mdx +++ b/docs/models/components/chatcontentfile.mdx @@ -9,5 +9,5 @@ File content part for document processing | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `File` | [components.File](../../models/components/file.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatContentFileType](../../models/components/chatcontentfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `File` | [components.File](../../models/components/file) | :heavy_check_mark: | N/A | +| `Type` | [components.ChatContentFileType](../../models/components/chatcontentfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatcontentimage.mdx b/docs/models/components/chatcontentimage.mdx index 7978182c..85ff2109 100644 --- a/docs/models/components/chatcontentimage.mdx +++ b/docs/models/components/chatcontentimage.mdx @@ -9,5 +9,5 @@ Image content part for vision models | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ChatContentImageImageURL](../../models/components/chatcontentimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatContentImageType](../../models/components/chatcontentimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.ChatContentImageImageURL](../../models/components/chatcontentimageimageurl) | :heavy_check_mark: | N/A | +| `Type` | [components.ChatContentImageType](../../models/components/chatcontentimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatcontentimageimageurl.mdx b/docs/models/components/chatcontentimageimageurl.mdx index 4e9eaec2..c27f339d 100644 --- a/docs/models/components/chatcontentimageimageurl.mdx +++ b/docs/models/components/chatcontentimageimageurl.mdx @@ -6,5 +6,5 @@ title: "ChatContentImageImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Detail` | [*components.ChatContentImageDetail](../../models/components/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. | +| `Detail` | [*components.ChatContentImageDetail](../../models/components/chatcontentimagedetail) | :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 diff --git a/docs/models/components/chatcontenttext.mdx b/docs/models/components/chatcontenttext.mdx index 923d6d42..8630bd02 100644 --- a/docs/models/components/chatcontenttext.mdx +++ b/docs/models/components/chatcontenttext.mdx @@ -9,7 +9,7 @@ Text content part | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/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` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/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"
} | +| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol) | :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` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint)] | :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` | [components.ChatContentTextType](../../models/components/chatcontenttexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.ChatContentTextType](../../models/components/chatcontenttexttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatcontentvideo.mdx b/docs/models/components/chatcontentvideo.mdx index 9b545f87..5fe140f5 100644 --- a/docs/models/components/chatcontentvideo.mdx +++ b/docs/models/components/chatcontentvideo.mdx @@ -9,5 +9,5 @@ Video input content part | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Type` | [components.ChatContentVideoType](../../models/components/chatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | -| `VideoURL` | [components.ChatContentVideoInput](../../models/components/chatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `Type` | [components.ChatContentVideoType](../../models/components/chatcontentvideotype) | :heavy_check_mark: | N/A | | +| `VideoURL` | [components.ChatContentVideoInput](../../models/components/chatcontentvideoinput) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/components/chatdevelopermessage.mdx b/docs/models/components/chatdevelopermessage.mdx index e7e22fc4..833e92d4 100644 --- a/docs/models/components/chatdevelopermessage.mdx +++ b/docs/models/components/chatdevelopermessage.mdx @@ -9,6 +9,6 @@ Developer message | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Content` | [components.ChatDeveloperMessageContent](../../models/components/chatdevelopermessagecontent.mdx) | :heavy_check_mark: | Developer message content | This is a message from the developer. | +| `Content` | [components.ChatDeveloperMessageContent](../../models/components/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` | [components.ChatDeveloperMessageRole](../../models/components/chatdevelopermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Role` | [components.ChatDeveloperMessageRole](../../models/components/chatdevelopermessagerole) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatformatgrammarconfig.mdx b/docs/models/components/chatformatgrammarconfig.mdx index 27fd2d49..8ec9ba8c 100644 --- a/docs/models/components/chatformatgrammarconfig.mdx +++ b/docs/models/components/chatformatgrammarconfig.mdx @@ -10,4 +10,4 @@ Custom grammar response format | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | `Grammar` | `string` | :heavy_check_mark: | Custom grammar for text generation | root ::= "yes" \| "no" | -| `Type` | [components.ChatFormatGrammarConfigType](../../models/components/chatformatgrammarconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.ChatFormatGrammarConfigType](../../models/components/chatformatgrammarconfigtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatformatjsonobjectconfig.mdx b/docs/models/components/chatformatjsonobjectconfig.mdx index dd1a41d3..d1640568 100644 --- a/docs/models/components/chatformatjsonobjectconfig.mdx +++ b/docs/models/components/chatformatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Type` | [components.ChatFormatJSONObjectConfigType](../../models/components/chatformatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ChatFormatJSONObjectConfigType](../../models/components/chatformatjsonobjectconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatformatjsonschemaconfig.mdx b/docs/models/components/chatformatjsonschemaconfig.mdx index 269e7ca5..8f24701a 100644 --- a/docs/models/components/chatformatjsonschemaconfig.mdx +++ b/docs/models/components/chatformatjsonschemaconfig.mdx @@ -9,5 +9,5 @@ JSON Schema response format for structured outputs | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `JSONSchema` | [components.ChatJSONSchemaConfig](../../models/components/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` | [components.ChatFormatJSONSchemaConfigType](../../models/components/chatformatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `JSONSchema` | [components.ChatJSONSchemaConfig](../../models/components/chatjsonschemaconfig) | :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` | [components.ChatFormatJSONSchemaConfigType](../../models/components/chatformatjsonschemaconfigtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatformatpythonconfig.mdx b/docs/models/components/chatformatpythonconfig.mdx index 5930db0a..9334268d 100644 --- a/docs/models/components/chatformatpythonconfig.mdx +++ b/docs/models/components/chatformatpythonconfig.mdx @@ -9,4 +9,4 @@ Python code response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.ChatFormatPythonConfigType](../../models/components/chatformatpythonconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ChatFormatPythonConfigType](../../models/components/chatformatpythonconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatformattextconfig.mdx b/docs/models/components/chatformattextconfig.mdx index 104071e7..e07675ae 100644 --- a/docs/models/components/chatformattextconfig.mdx +++ b/docs/models/components/chatformattextconfig.mdx @@ -9,4 +9,4 @@ Default text response format | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Type` | [components.ChatFormatTextConfigType](../../models/components/chatformattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ChatFormatTextConfigType](../../models/components/chatformattextconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatfunctiontoolfunction.mdx b/docs/models/components/chatfunctiontoolfunction.mdx index 7abed15a..5c19fc36 100644 --- a/docs/models/components/chatfunctiontoolfunction.mdx +++ b/docs/models/components/chatfunctiontoolfunction.mdx @@ -6,6 +6,6 @@ title: "ChatFunctionToolFunction" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/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` | [components.ChatFunctionToolFunctionFunction](../../models/components/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` | [components.ChatFunctionToolType](../../models/components/chatfunctiontooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.ChatContentCacheControl](../../models/components/chatcontentcachecontrol) | :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` | [components.ChatFunctionToolFunctionFunction](../../models/components/chatfunctiontoolfunctionfunction) | :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` | [components.ChatFunctionToolType](../../models/components/chatfunctiontooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatnamedtoolchoice.mdx b/docs/models/components/chatnamedtoolchoice.mdx index d3a4959c..358babf9 100644 --- a/docs/models/components/chatnamedtoolchoice.mdx +++ b/docs/models/components/chatnamedtoolchoice.mdx @@ -9,5 +9,5 @@ Named tool choice for specific function | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Function` | [components.ChatNamedToolChoiceFunction](../../models/components/chatnamedtoolchoicefunction.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ChatNamedToolChoiceType](../../models/components/chatnamedtoolchoicetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Function` | [components.ChatNamedToolChoiceFunction](../../models/components/chatnamedtoolchoicefunction) | :heavy_check_mark: | N/A | +| `Type` | [components.ChatNamedToolChoiceType](../../models/components/chatnamedtoolchoicetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chatrequest.mdx b/docs/models/components/chatrequest.mdx index 03aa5f26..f41a3421 100644 --- a/docs/models/components/chatrequest.mdx +++ b/docs/models/components/chatrequest.mdx @@ -9,44 +9,44 @@ Chat completion request parameters | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | | `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Frequency penalty (-2.0 to 2.0) | 0 | -| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | :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"
} | +| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig) | :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` | optionalnullable.OptionalNullable[map[string]`float64`] | :heavy_minus_sign: | Token logit bias adjustments | \{
"50256": -100
} | | `Logprobs` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Return log probabilities | false | | `MaxCompletionTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum tokens in completion | 100 | | `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Maximum tokens (deprecated, use max_completion_tokens). Note: some providers enforce a minimum of 16. | 100 | -| `Messages` | [][components.ChatMessages](../../models/components/chatmessages.mdx) | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | +| `Messages` | [][components.ChatMessages](../../models/components/chatmessages) | :heavy_check_mark: | List of messages for the conversation | [
\{
"content": "Hello!",
"role": "user"
}
] | | `Metadata` | map[string]`string` | :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` | optionalnullable.OptionalNullable[`float64`] | :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` | [][components.Modality](../../models/components/modality.mdx) | :heavy_minus_sign: | Output modalities for the response. Supported values are "text", "image", and "audio". | [
"text",
"image"
] | +| `Modalities` | [][components.Modality](../../models/components/modality) | :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` | optionalnullable.OptionalNullable[`bool`] | :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` | [][components.ChatRequestPlugin](../../models/components/chatrequestplugin.mdx) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `Prediction` | optionalnullable.OptionalNullable[[components.Prediction](../../models/components/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"
} | +| `Plugins` | [][components.ChatRequestPlugin](../../models/components/chatrequestplugin) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `Prediction` | optionalnullable.OptionalNullable[[components.Prediction](../../models/components/prediction)] | :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` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Presence penalty (-2.0 to 2.0) | 0 | | `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/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` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `Reasoning` | [*components.ChatRequestReasoning](../../models/components/chatrequestreasoning.mdx) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | -| `ReasoningEffort` | optionalnullable.OptionalNullable[[components.ChatRequestReasoningEffort](../../models/components/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 | +| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions)] | :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` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `Reasoning` | [*components.ChatRequestReasoning](../../models/components/chatrequestreasoning) | :heavy_minus_sign: | Configuration options for reasoning models | \{
"effort": "medium",
"summary": "concise"
} | +| `ReasoningEffort` | optionalnullable.OptionalNullable[[components.ChatRequestReasoningEffort](../../models/components/chatrequestreasoningeffort)] | :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` | optionalnullable.OptionalNullable[`float64`] | :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` | [*components.ResponseFormat](../../models/components/responseformat.mdx) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | +| `ResponseFormat` | [*components.ResponseFormat](../../models/components/responseformat) | :heavy_minus_sign: | Response format configuration | \{
"type": "json_object"
} | | `Seed` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Random seed for deterministic outputs | 42 | -| `ServiceTier` | optionalnullable.OptionalNullable[[components.ChatRequestServiceTier](../../models/components/chatrequestservicetier.mdx)] | :heavy_minus_sign: | The service tier to use for processing this request. | auto | +| `ServiceTier` | optionalnullable.OptionalNullable[[components.ChatRequestServiceTier](../../models/components/chatrequestservicetier)] | :heavy_minus_sign: | The service tier to use for processing this request. | 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` | optionalnullable.OptionalNullable[[components.Stop](../../models/components/stop.mdx)] | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | :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"
}
] | +| `Stop` | optionalnullable.OptionalNullable[[components.Stop](../../models/components/stop)] | :heavy_minus_sign: | Stop sequences (up to 4) | [
"\n"
] | +| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/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` | `*bool` | :heavy_minus_sign: | Enable streaming response | false | -| `StreamOptions` | optionalnullable.OptionalNullable[[components.ChatStreamOptions](../../models/components/chatstreamoptions.mdx)] | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | +| `StreamOptions` | optionalnullable.OptionalNullable[[components.ChatStreamOptions](../../models/components/chatstreamoptions)] | :heavy_minus_sign: | Streaming configuration options | \{
"include_usage": true
} | | `Temperature` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Sampling temperature (0-2) | 0.7 | -| `ToolChoice` | [*components.ChatToolChoice](../../models/components/chattoolchoice.mdx) | :heavy_minus_sign: | Tool choice configuration | auto | -| `Tools` | [][components.ChatFunctionTool](../../models/components/chatfunctiontool.mdx) | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | +| `ToolChoice` | [*components.ChatToolChoice](../../models/components/chattoolchoice) | :heavy_minus_sign: | Tool choice configuration | auto | +| `Tools` | [][components.ChatFunctionTool](../../models/components/chatfunctiontool) | :heavy_minus_sign: | Available tools for function calling | [
\{
"function": \{
"description": "Get weather",
"name": "get_weather"
},
"type": "function"
}
] | | `TopA` | optionalnullable.OptionalNullable[`float64`] | :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` | optionalnullable.OptionalNullable[`int64`] | :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` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of top log probabilities to return (0-20) | 5 | | `TopP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Nucleus sampling parameter (0-1) | 1 | -| `Trace` | [*components.TraceConfig](../../models/components/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"
} | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig) | :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 diff --git a/docs/models/components/chatrequestreasoning.mdx b/docs/models/components/chatrequestreasoning.mdx index bd0c82b7..4e632b6b 100644 --- a/docs/models/components/chatrequestreasoning.mdx +++ b/docs/models/components/chatrequestreasoning.mdx @@ -9,5 +9,5 @@ Configuration options for reasoning models | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.ChatRequestEffort](../../models/components/chatrequesteffort.mdx)] | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | -| `Summary` | optionalnullable.OptionalNullable[[components.ChatReasoningSummaryVerbosityEnum](../../models/components/chatreasoningsummaryverbosityenum.mdx)] | :heavy_minus_sign: | N/A | concise | \ No newline at end of file +| `Effort` | optionalnullable.OptionalNullable[[components.ChatRequestEffort](../../models/components/chatrequesteffort)] | :heavy_minus_sign: | Constrains effort on reasoning for reasoning models | medium | +| `Summary` | optionalnullable.OptionalNullable[[components.ChatReasoningSummaryVerbosityEnum](../../models/components/chatreasoningsummaryverbosityenum)] | :heavy_minus_sign: | N/A | concise | \ No newline at end of file diff --git a/docs/models/components/chatresult.mdx b/docs/models/components/chatresult.mdx index 7afbebe7..7595ca33 100644 --- a/docs/models/components/chatresult.mdx +++ b/docs/models/components/chatresult.mdx @@ -9,12 +9,12 @@ Chat completion response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.ChatChoice](../../models/components/chatchoice.mdx) | :heavy_check_mark: | List of completion choices | | +| `Choices` | [][components.ChatChoice](../../models/components/chatchoice) | :heavy_check_mark: | List of completion choices | | | `Created` | `int64` | :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` | [components.ChatResultObject](../../models/components/chatresultobject.mdx) | :heavy_check_mark: | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `Object` | [components.ChatResultObject](../../models/components/chatresultobject) | :heavy_check_mark: | N/A | | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | | `ServiceTier` | optionalnullable.OptionalNullable[`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` | [*components.ChatUsage](../../models/components/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 +| `Usage` | [*components.ChatUsage](../../models/components/chatusage) | :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 diff --git a/docs/models/components/chatsearchmodelsservertool.mdx b/docs/models/components/chatsearchmodelsservertool.mdx index 55ce5ec9..506adcf2 100644 --- a/docs/models/components/chatsearchmodelsservertool.mdx +++ b/docs/models/components/chatsearchmodelsservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches and filters AI models available on Ope | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `Type` | [components.ChatSearchModelsServerToolType](../../models/components/chatsearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `Type` | [components.ChatSearchModelsServerToolType](../../models/components/chatsearchmodelsservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatstreamchoice.mdx b/docs/models/components/chatstreamchoice.mdx index ace80d15..acae3d17 100644 --- a/docs/models/components/chatstreamchoice.mdx +++ b/docs/models/components/chatstreamchoice.mdx @@ -9,7 +9,7 @@ Streaming completion choice chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Delta` | [components.ChatStreamDelta](../../models/components/chatstreamdelta.mdx) | :heavy_check_mark: | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | -| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum.mdx) | :heavy_check_mark: | N/A | stop | +| `Delta` | [components.ChatStreamDelta](../../models/components/chatstreamdelta) | :heavy_check_mark: | Delta changes in streaming response | \{
"content": "Hello",
"role": "assistant"
} | +| `FinishReason` | [*components.ChatFinishReasonEnum](../../models/components/chatfinishreasonenum) | :heavy_check_mark: | N/A | stop | | `Index` | `int64` | :heavy_check_mark: | Choice index | 0 | -| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/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 +| `Logprobs` | optionalnullable.OptionalNullable[[components.ChatTokenLogprobs](../../models/components/chattokenlogprobs)] | :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 diff --git a/docs/models/components/chatstreamchunk.mdx b/docs/models/components/chatstreamchunk.mdx index 9255a8f4..34558ba5 100644 --- a/docs/models/components/chatstreamchunk.mdx +++ b/docs/models/components/chatstreamchunk.mdx @@ -9,13 +9,13 @@ Streaming chat completion chunk | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Choices` | [][components.ChatStreamChoice](../../models/components/chatstreamchoice.mdx) | :heavy_check_mark: | List of streaming chunk choices | | +| `Choices` | [][components.ChatStreamChoice](../../models/components/chatstreamchoice) | :heavy_check_mark: | List of streaming chunk choices | | | `Created` | `int64` | :heavy_check_mark: | Unix timestamp of creation | 1677652288 | -| `Error` | [*components.ChatStreamChunkError](../../models/components/chatstreamchunkerror.mdx) | :heavy_minus_sign: | Error information | \{
"code": 429,
"message": "Rate limit exceeded",
"metadata": \{
"error_type": "rate_limit_exceeded"
}
} | +| `Error` | [*components.ChatStreamChunkError](../../models/components/chatstreamchunkerror) | :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` | [components.ChatStreamChunkObject](../../models/components/chatstreamchunkobject.mdx) | :heavy_check_mark: | N/A | | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | +| `Object` | [components.ChatStreamChunkObject](../../models/components/chatstreamchunkobject) | :heavy_check_mark: | N/A | | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | | `ServiceTier` | optionalnullable.OptionalNullable[`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` | [*components.ChatUsage](../../models/components/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 +| `Usage` | [*components.ChatUsage](../../models/components/chatusage) | :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 diff --git a/docs/models/components/chatstreamchunkerror.mdx b/docs/models/components/chatstreamchunkerror.mdx index b5d7abc1..0f1303bb 100644 --- a/docs/models/components/chatstreamchunkerror.mdx +++ b/docs/models/components/chatstreamchunkerror.mdx @@ -11,4 +11,4 @@ Error information | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | `Code` | `int` | :heavy_check_mark: | Error code | 429 | | `Message` | `string` | :heavy_check_mark: | Error message | Rate limit exceeded | -| `Metadata` | [*components.ChatStreamChunkMetadata](../../models/components/chatstreamchunkmetadata.mdx) | :heavy_minus_sign: | Structured error metadata | | \ No newline at end of file +| `Metadata` | [*components.ChatStreamChunkMetadata](../../models/components/chatstreamchunkmetadata) | :heavy_minus_sign: | Structured error metadata | | \ No newline at end of file diff --git a/docs/models/components/chatstreamchunkmetadata.mdx b/docs/models/components/chatstreamchunkmetadata.mdx index 249b702b..11d7d156 100644 --- a/docs/models/components/chatstreamchunkmetadata.mdx +++ b/docs/models/components/chatstreamchunkmetadata.mdx @@ -9,5 +9,5 @@ Structured error metadata | Field | Type | Required | Description | Example | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `ErrorType` | [components.APIErrorType](../../models/components/apierrortype.mdx) | :heavy_check_mark: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `ErrorType` | [components.APIErrorType](../../models/components/apierrortype) | :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 diff --git a/docs/models/components/chatstreamdelta.mdx b/docs/models/components/chatstreamdelta.mdx index e09e1eec..934d0667 100644 --- a/docs/models/components/chatstreamdelta.mdx +++ b/docs/models/components/chatstreamdelta.mdx @@ -9,10 +9,10 @@ Delta changes in streaming response | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput.mdx) | :heavy_minus_sign: | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | +| `Audio` | [*components.ChatAudioOutput](../../models/components/chataudiooutput) | :heavy_minus_sign: | N/A | \{
"data": "UklGRnoGAABXQVZFZm10IBAAAAABAAEAQB8AAEAfAAABAAgAZGF0YQoGAACBhYqFbF1f",
"expires_at": 1677652400,
"id": "audio_abc123",
"transcript": "Hello! How can I help you today?"
} | | `Content` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Message content delta | Hello | | `Reasoning` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Reasoning content delta | I need to | -| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion.mdx) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | +| `ReasoningDetails` | [][components.ReasoningDetailUnion](../../models/components/reasoningdetailunion) | :heavy_minus_sign: | Reasoning details for extended thinking models | [
\{
"text": "Let me think about this...",
"type": "reasoning.text"
}
] | | `Refusal` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Refusal message delta | null | -| `Role` | [*components.ChatStreamDeltaRole](../../models/components/chatstreamdeltarole.mdx) | :heavy_minus_sign: | The role of the message author | assistant | -| `ToolCalls` | [][components.ChatStreamToolCall](../../models/components/chatstreamtoolcall.mdx) | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file +| `Role` | [*components.ChatStreamDeltaRole](../../models/components/chatstreamdeltarole) | :heavy_minus_sign: | The role of the message author | assistant | +| `ToolCalls` | [][components.ChatStreamToolCall](../../models/components/chatstreamtoolcall) | :heavy_minus_sign: | Tool calls delta | | \ No newline at end of file diff --git a/docs/models/components/chatstreamingresponse.mdx b/docs/models/components/chatstreamingresponse.mdx index fffbbb27..a1d07c5c 100644 --- a/docs/models/components/chatstreamingresponse.mdx +++ b/docs/models/components/chatstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ChatStreamingResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ChatStreamChunk](../../models/components/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` | [components.ChatStreamChunk](../../models/components/chatstreamchunk) | :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 diff --git a/docs/models/components/chatstreamtoolcall.mdx b/docs/models/components/chatstreamtoolcall.mdx index 6f5e9e45..bb0b7940 100644 --- a/docs/models/components/chatstreamtoolcall.mdx +++ b/docs/models/components/chatstreamtoolcall.mdx @@ -9,7 +9,7 @@ Tool call delta for streaming responses | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Function` | [*components.ChatStreamToolCallFunction](../../models/components/chatstreamtoolcallfunction.mdx) | :heavy_minus_sign: | Function call details | | +| `Function` | [*components.ChatStreamToolCallFunction](../../models/components/chatstreamtoolcallfunction) | :heavy_minus_sign: | Function call details | | | `ID` | `*string` | :heavy_minus_sign: | Tool call identifier | call_abc123 | | `Index` | `int64` | :heavy_check_mark: | Tool call index in the array | 0 | -| `Type` | [*components.ChatStreamToolCallType](../../models/components/chatstreamtoolcalltype.mdx) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file +| `Type` | [*components.ChatStreamToolCallType](../../models/components/chatstreamtoolcalltype) | :heavy_minus_sign: | Tool call type | function | \ No newline at end of file diff --git a/docs/models/components/chatsystemmessage.mdx b/docs/models/components/chatsystemmessage.mdx index 7cdcfe98..d7905a4f 100644 --- a/docs/models/components/chatsystemmessage.mdx +++ b/docs/models/components/chatsystemmessage.mdx @@ -9,6 +9,6 @@ System message for setting behavior | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Content` | [components.ChatSystemMessageContent](../../models/components/chatsystemmessagecontent.mdx) | :heavy_check_mark: | System message content | You are a helpful assistant. | +| `Content` | [components.ChatSystemMessageContent](../../models/components/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` | [components.ChatSystemMessageRole](../../models/components/chatsystemmessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Role` | [components.ChatSystemMessageRole](../../models/components/chatsystemmessagerole) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chattokenlogprob.mdx b/docs/models/components/chattokenlogprob.mdx index b1543a48..520ed9a0 100644 --- a/docs/models/components/chattokenlogprob.mdx +++ b/docs/models/components/chattokenlogprob.mdx @@ -12,4 +12,4 @@ Token log probability information | `Bytes` | []`int64` | :heavy_check_mark: | UTF-8 bytes of the token | | `Logprob` | `float64` | :heavy_check_mark: | Log probability of the token | | `Token` | `string` | :heavy_check_mark: | The token | -| `TopLogprobs` | [][components.ChatTokenLogprobTopLogprob](../../models/components/chattokenlogprobtoplogprob.mdx) | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file +| `TopLogprobs` | [][components.ChatTokenLogprobTopLogprob](../../models/components/chattokenlogprobtoplogprob) | :heavy_check_mark: | Top alternative tokens with probabilities | \ No newline at end of file diff --git a/docs/models/components/chattokenlogprobs.mdx b/docs/models/components/chattokenlogprobs.mdx index 067f0fcd..d0242e72 100644 --- a/docs/models/components/chattokenlogprobs.mdx +++ b/docs/models/components/chattokenlogprobs.mdx @@ -9,5 +9,5 @@ Log probabilities for the completion | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx) | :heavy_check_mark: | Log probabilities for content tokens | -| `Refusal` | optionalnullable.OptionalNullable[[][components.ChatTokenLogprob](../../models/components/chattokenlogprob.mdx)] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file +| `Content` | [][components.ChatTokenLogprob](../../models/components/chattokenlogprob) | :heavy_check_mark: | Log probabilities for content tokens | +| `Refusal` | optionalnullable.OptionalNullable[[][components.ChatTokenLogprob](../../models/components/chattokenlogprob)] | :heavy_minus_sign: | Log probabilities for refusal tokens | \ No newline at end of file diff --git a/docs/models/components/chattoolcall.mdx b/docs/models/components/chattoolcall.mdx index 61d05966..7fd5a8ec 100644 --- a/docs/models/components/chattoolcall.mdx +++ b/docs/models/components/chattoolcall.mdx @@ -9,6 +9,6 @@ Tool call made by the assistant | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Function` | [components.ChatToolCallFunction](../../models/components/chattoolcallfunction.mdx) | :heavy_check_mark: | N/A | +| `Function` | [components.ChatToolCallFunction](../../models/components/chattoolcallfunction) | :heavy_check_mark: | N/A | | `ID` | `string` | :heavy_check_mark: | Tool call identifier | -| `Type` | [components.ChatToolCallType](../../models/components/chattoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ChatToolCallType](../../models/components/chattoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/chattoolmessage.mdx b/docs/models/components/chattoolmessage.mdx index 894285e3..36d9fdce 100644 --- a/docs/models/components/chattoolmessage.mdx +++ b/docs/models/components/chattoolmessage.mdx @@ -9,6 +9,6 @@ Tool response message | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Content` | [components.ChatToolMessageContent](../../models/components/chattoolmessagecontent.mdx) | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | -| `Role` | [components.ChatToolMessageRole](../../models/components/chattoolmessagerole.mdx) | :heavy_check_mark: | N/A | | +| `Content` | [components.ChatToolMessageContent](../../models/components/chattoolmessagecontent) | :heavy_check_mark: | Tool response content | The weather in San Francisco is 72°F and sunny. | +| `Role` | [components.ChatToolMessageRole](../../models/components/chattoolmessagerole) | :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 diff --git a/docs/models/components/chatusage.mdx b/docs/models/components/chatusage.mdx index 38ad89e6..7e58c472 100644 --- a/docs/models/components/chatusage.mdx +++ b/docs/models/components/chatusage.mdx @@ -10,11 +10,11 @@ Token usage statistics | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `CompletionTokens` | `int64` | :heavy_check_mark: | Number of tokens in the completion | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsageCompletionTokensDetails](../../models/components/chatusagecompletiontokensdetails.mdx)] | :heavy_minus_sign: | Detailed completion token usage | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsageCompletionTokensDetails](../../models/components/chatusagecompletiontokensdetails)] | :heavy_minus_sign: | Detailed completion token usage | | | `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/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
} | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails)] | :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` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | | `PromptTokens` | `int64` | :heavy_check_mark: | Number of tokens in the prompt | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsagePromptTokensDetails](../../models/components/chatusageprompttokensdetails.mdx)] | :heavy_minus_sign: | Detailed prompt token usage | | -| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/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
} | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ChatUsagePromptTokensDetails](../../models/components/chatusageprompttokensdetails)] | :heavy_minus_sign: | Detailed prompt token usage | | +| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails)] | :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` | `int64` | :heavy_check_mark: | Total number of tokens | | \ No newline at end of file diff --git a/docs/models/components/chatusermessage.mdx b/docs/models/components/chatusermessage.mdx index d1bf5ce4..3a7e6e9b 100644 --- a/docs/models/components/chatusermessage.mdx +++ b/docs/models/components/chatusermessage.mdx @@ -9,6 +9,6 @@ User message | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Content` | [components.ChatUserMessageContent](../../models/components/chatusermessagecontent.mdx) | :heavy_check_mark: | User message content | What is the capital of France? | +| `Content` | [components.ChatUserMessageContent](../../models/components/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` | [components.ChatUserMessageRole](../../models/components/chatusermessagerole.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Role` | [components.ChatUserMessageRole](../../models/components/chatusermessagerole) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/chatwebsearchshorthand.mdx b/docs/models/components/chatwebsearchshorthand.mdx index c5924eb6..43aaf44c 100644 --- a/docs/models/components/chatwebsearchshorthand.mdx +++ b/docs/models/components/chatwebsearchshorthand.mdx @@ -10,13 +10,13 @@ Web search tool using OpenAI Responses API syntax. Automatically converted to op | 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, xAI). Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/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 | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum) | :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 xAI. Cannot be used with allowed_domains. | | | `MaxCharacters` | `*int64` | :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` | `*int64` | :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` | `*int64` | :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` | `*int64` | :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 | -| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/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` | [components.ChatWebSearchShorthandType](../../models/components/chatwebsearchshorthandtype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/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"
} | \ No newline at end of file +| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel) | :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` | [components.ChatWebSearchShorthandType](../../models/components/chatwebsearchshorthandtype) | :heavy_check_mark: | N/A | | +| `UserLocation` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/codeinterpreterservertool.mdx b/docs/models/components/codeinterpreterservertool.mdx index 9a854435..3503c7a4 100644 --- a/docs/models/components/codeinterpreterservertool.mdx +++ b/docs/models/components/codeinterpreterservertool.mdx @@ -9,5 +9,5 @@ Code interpreter tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Container` | [components.Container](../../models/components/container.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.TypeCodeInterpreter](../../models/components/typecodeinterpreter.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Container` | [components.Container](../../models/components/container) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeCodeInterpreter](../../models/components/typecodeinterpreter) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/codexlocalshelltool.mdx b/docs/models/components/codexlocalshelltool.mdx index 7f7725af..034dfd9a 100644 --- a/docs/models/components/codexlocalshelltool.mdx +++ b/docs/models/components/codexlocalshelltool.mdx @@ -9,4 +9,4 @@ Local shell tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Type` | [components.CodexLocalShellToolType](../../models/components/codexlocalshelltooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.CodexLocalShellToolType](../../models/components/codexlocalshelltooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/compactionitem.mdx b/docs/models/components/compactionitem.mdx index b7b846c9..b8137fec 100644 --- a/docs/models/components/compactionitem.mdx +++ b/docs/models/components/compactionitem.mdx @@ -11,5 +11,5 @@ A context compaction marker with encrypted summary | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `EncryptedContent` | `string` | :heavy_check_mark: | N/A | | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.CompactionItemType](../../models/components/compactionitemtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.CompactionItemType](../../models/components/compactionitemtype) | :heavy_check_mark: | N/A | | | `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "compaction"
} | \ No newline at end of file diff --git a/docs/models/components/compoundfilter.mdx b/docs/models/components/compoundfilter.mdx index 7fbf1362..26acc036 100644 --- a/docs/models/components/compoundfilter.mdx +++ b/docs/models/components/compoundfilter.mdx @@ -10,4 +10,4 @@ A compound filter that combines multiple comparison or compound filters | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `Filters` | []map[string]`any` | :heavy_check_mark: | N/A | -| `Type` | [components.CompoundFilterType](../../models/components/compoundfiltertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.CompoundFilterType](../../models/components/compoundfiltertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/computeruseservertool.mdx b/docs/models/components/computeruseservertool.mdx index 33b8f8fc..b220fd24 100644 --- a/docs/models/components/computeruseservertool.mdx +++ b/docs/models/components/computeruseservertool.mdx @@ -11,5 +11,5 @@ Computer use preview tool configuration | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `DisplayHeight` | `int64` | :heavy_check_mark: | N/A | | `DisplayWidth` | `int64` | :heavy_check_mark: | N/A | -| `Environment` | [components.Environment](../../models/components/environment.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ComputerUseServerToolType](../../models/components/computeruseservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Environment` | [components.Environment](../../models/components/environment) | :heavy_check_mark: | N/A | +| `Type` | [components.ComputerUseServerToolType](../../models/components/computeruseservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/containerauto.mdx b/docs/models/components/containerauto.mdx index f0a61aa6..e20cda49 100644 --- a/docs/models/components/containerauto.mdx +++ b/docs/models/components/containerauto.mdx @@ -7,5 +7,5 @@ title: "ContainerAuto" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | `FileIds` | []`string` | :heavy_minus_sign: | N/A | -| `MemoryLimit` | optionalnullable.OptionalNullable[[components.MemoryLimit](../../models/components/memorylimit.mdx)] | :heavy_minus_sign: | N/A | -| `Type` | [components.ContainerType](../../models/components/containertype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `MemoryLimit` | optionalnullable.OptionalNullable[[components.MemoryLimit](../../models/components/memorylimit)] | :heavy_minus_sign: | N/A | +| `Type` | [components.ContainerType](../../models/components/containertype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/containerautoenvironment.mdx b/docs/models/components/containerautoenvironment.mdx index e534f62b..278819f3 100644 --- a/docs/models/components/containerautoenvironment.mdx +++ b/docs/models/components/containerautoenvironment.mdx @@ -9,4 +9,4 @@ An OpenRouter-managed, auto-provisioned ephemeral container. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Type` | [components.ContainerAutoEnvironmentType](../../models/components/containerautoenvironmenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ContainerAutoEnvironmentType](../../models/components/containerautoenvironmenttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/containerreferenceenvironment.mdx b/docs/models/components/containerreferenceenvironment.mdx index 458d9d50..0b2b13ce 100644 --- a/docs/models/components/containerreferenceenvironment.mdx +++ b/docs/models/components/containerreferenceenvironment.mdx @@ -10,4 +10,4 @@ Reference to a previously created container to reuse. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `ContainerID` | `string` | :heavy_check_mark: | Identifier of an existing container to reuse (max 20 characters). | cntr_abc123 | -| `Type` | [components.ContainerReferenceEnvironmentType](../../models/components/containerreferenceenvironmenttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.ContainerReferenceEnvironmentType](../../models/components/containerreferenceenvironmenttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentcompaction.mdx b/docs/models/components/contentcompaction.mdx index c29bc332..3c8daeca 100644 --- a/docs/models/components/contentcompaction.mdx +++ b/docs/models/components/contentcompaction.mdx @@ -6,7 +6,7 @@ title: "ContentCompaction" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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"
} | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.MessagesMessageParamTypeCompaction](../../models/components/messagesmessageparamtypecompaction.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.MessagesMessageParamTypeCompaction](../../models/components/messagesmessageparamtypecompaction) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentencryptedcontent.mdx b/docs/models/components/contentencryptedcontent.mdx index ddd84c8e..268a9846 100644 --- a/docs/models/components/contentencryptedcontent.mdx +++ b/docs/models/components/contentencryptedcontent.mdx @@ -7,5 +7,5 @@ title: "ContentEncryptedContent" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `EncryptedContent` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeEncryptedContent](../../models/components/typeencryptedcontent.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeEncryptedContent](../../models/components/typeencryptedcontent) | :heavy_check_mark: | N/A | | `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentfilterbuiltinentry.mdx b/docs/models/components/contentfilterbuiltinentry.mdx index 7150b089..e2e6da9e 100644 --- a/docs/models/components/contentfilterbuiltinentry.mdx +++ b/docs/models/components/contentfilterbuiltinentry.mdx @@ -9,7 +9,7 @@ A builtin content filter entry. Builtin filters include PII detectors and the re | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | +| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction) | :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` | [*components.PromptInjectionScanScope](../../models/components/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` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope) | :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` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/components/contentfilterbuiltinentryinput.mdx b/docs/models/components/contentfilterbuiltinentryinput.mdx index 5a92789b..15cbaec1 100644 --- a/docs/models/components/contentfilterbuiltinentryinput.mdx +++ b/docs/models/components/contentfilterbuiltinentryinput.mdx @@ -9,7 +9,7 @@ A builtin content filter entry for create/update requests. Labels are system-ass | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction.mdx) | :heavy_check_mark: | Action taken when the builtin filter triggers | block | +| `Action` | [components.ContentFilterBuiltinAction](../../models/components/contentfilterbuiltinaction) | :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` | [*components.PromptInjectionScanScope](../../models/components/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` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug.mdx) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file +| `ScanScope` | [*components.PromptInjectionScanScope](../../models/components/promptinjectionscanscope) | :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` | [components.ContentFilterBuiltinSlug](../../models/components/contentfilterbuiltinslug) | :heavy_check_mark: | The builtin filter identifier | regex-prompt-injection | \ No newline at end of file diff --git a/docs/models/components/contentfilterentry.mdx b/docs/models/components/contentfilterentry.mdx index b48bd98f..f974e6df 100644 --- a/docs/models/components/contentfilterentry.mdx +++ b/docs/models/components/contentfilterentry.mdx @@ -9,6 +9,6 @@ A custom regex content filter that scans request messages for matching patterns. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Action` | [components.ContentFilterAction](../../models/components/contentfilteraction.mdx) | :heavy_check_mark: | Action taken when the pattern matches | block | +| `Action` | [components.ContentFilterAction](../../models/components/contentfilteraction) | :heavy_check_mark: | Action taken when the pattern matches | block | | `Label` | optionalnullable.OptionalNullable[`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 diff --git a/docs/models/components/contentpartaddedevent.mdx b/docs/models/components/contentpartaddedevent.mdx index 0ff8554c..ce529ff5 100644 --- a/docs/models/components/contentpartaddedevent.mdx +++ b/docs/models/components/contentpartaddedevent.mdx @@ -12,6 +12,6 @@ Event emitted when a new content part is added to an output item | `ContentIndex` | `int64` | :heavy_check_mark: | N/A | | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `Part` | [components.ContentPartAddedEventPart](../../models/components/contentpartaddedeventpart.mdx) | :heavy_check_mark: | N/A | +| `Part` | [components.ContentPartAddedEventPart](../../models/components/contentpartaddedeventpart) | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartAddedEventType](../../models/components/contentpartaddedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ContentPartAddedEventType](../../models/components/contentpartaddedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartaudio.mdx b/docs/models/components/contentpartaudio.mdx index caf67512..f8fec066 100644 --- a/docs/models/components/contentpartaudio.mdx +++ b/docs/models/components/contentpartaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartAudio" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `AudioURL` | [components.AudioURL](../../models/components/audiourl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartAudioType](../../models/components/contentpartaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `AudioURL` | [components.AudioURL](../../models/components/audiourl) | :heavy_check_mark: | N/A | +| `Type` | [components.ContentPartAudioType](../../models/components/contentpartaudiotype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartdoneevent.mdx b/docs/models/components/contentpartdoneevent.mdx index 864566ba..64536b63 100644 --- a/docs/models/components/contentpartdoneevent.mdx +++ b/docs/models/components/contentpartdoneevent.mdx @@ -12,6 +12,6 @@ Event emitted when a content part is complete | `ContentIndex` | `int64` | :heavy_check_mark: | N/A | | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | -| `Part` | [components.ContentPartDoneEventPart](../../models/components/contentpartdoneeventpart.mdx) | :heavy_check_mark: | N/A | +| `Part` | [components.ContentPartDoneEventPart](../../models/components/contentpartdoneeventpart) | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartDoneEventType](../../models/components/contentpartdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ContentPartDoneEventType](../../models/components/contentpartdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartimage.mdx b/docs/models/components/contentpartimage.mdx index 38f6d6a3..14a89424 100644 --- a/docs/models/components/contentpartimage.mdx +++ b/docs/models/components/contentpartimage.mdx @@ -6,5 +6,5 @@ title: "ContentPartImage" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `ImageURL` | [components.ContentPartImageImageURL](../../models/components/contentpartimageimageurl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.ContentPartImageType](../../models/components/contentpartimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [components.ContentPartImageImageURL](../../models/components/contentpartimageimageurl) | :heavy_check_mark: | N/A | +| `Type` | [components.ContentPartImageType](../../models/components/contentpartimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentpartinputaudio.mdx b/docs/models/components/contentpartinputaudio.mdx index 3a57ab34..a840ebe0 100644 --- a/docs/models/components/contentpartinputaudio.mdx +++ b/docs/models/components/contentpartinputaudio.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputAudio" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `InputAudio` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `Type` | [components.ContentPartInputAudioType](../../models/components/contentpartinputaudiotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `InputAudio` | [components.MultimodalMedia](../../models/components/multimodalmedia) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `Type` | [components.ContentPartInputAudioType](../../models/components/contentpartinputaudiotype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentpartinputfile.mdx b/docs/models/components/contentpartinputfile.mdx index 53966b87..588db6a0 100644 --- a/docs/models/components/contentpartinputfile.mdx +++ b/docs/models/components/contentpartinputfile.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputFile" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `InputFile` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `Type` | [components.ContentPartInputFileType](../../models/components/contentpartinputfiletype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `InputFile` | [components.MultimodalMedia](../../models/components/multimodalmedia) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `Type` | [components.ContentPartInputFileType](../../models/components/contentpartinputfiletype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentpartinputvideo.mdx b/docs/models/components/contentpartinputvideo.mdx index 8e03b747..f638e7e1 100644 --- a/docs/models/components/contentpartinputvideo.mdx +++ b/docs/models/components/contentpartinputvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartInputVideo" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `InputVideo` | [components.MultimodalMedia](../../models/components/multimodalmedia.mdx) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | -| `Type` | [components.ContentPartInputVideoType](../../models/components/contentpartinputvideotype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `InputVideo` | [components.MultimodalMedia](../../models/components/multimodalmedia) | :heavy_check_mark: | N/A | \{
"data": "data:audio/wav;base64,UklGRiQAAABXQVZFZm10IBAAAAA...",
"format": "wav"
} | +| `Type` | [components.ContentPartInputVideoType](../../models/components/contentpartinputvideotype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentpartvideo.mdx b/docs/models/components/contentpartvideo.mdx index 42e9a7d2..64f22421 100644 --- a/docs/models/components/contentpartvideo.mdx +++ b/docs/models/components/contentpartvideo.mdx @@ -6,5 +6,5 @@ title: "ContentPartVideo" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Type` | [components.ContentPartVideoType](../../models/components/contentpartvideotype.mdx) | :heavy_check_mark: | N/A | -| `VideoURL` | [components.VideoURL](../../models/components/videourl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ContentPartVideoType](../../models/components/contentpartvideotype) | :heavy_check_mark: | N/A | +| `VideoURL` | [components.VideoURL](../../models/components/videourl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentredactedthinking.mdx b/docs/models/components/contentredactedthinking.mdx index 05bfa3ca..bffd33bb 100644 --- a/docs/models/components/contentredactedthinking.mdx +++ b/docs/models/components/contentredactedthinking.mdx @@ -7,4 +7,4 @@ title: "ContentRedactedThinking" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `Data` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeRedactedThinking](../../models/components/typeredactedthinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeRedactedThinking](../../models/components/typeredactedthinking) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contentservertooluse.mdx b/docs/models/components/contentservertooluse.mdx index 4e0cd115..4c9140ac 100644 --- a/docs/models/components/contentservertooluse.mdx +++ b/docs/models/components/contentservertooluse.mdx @@ -6,8 +6,8 @@ title: "ContentServerToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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"
} | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [components.TypeServerToolUse](../../models/components/typeservertooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.TypeServerToolUse](../../models/components/typeservertooluse) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentthinking.mdx b/docs/models/components/contentthinking.mdx index 99243be9..8717e26f 100644 --- a/docs/models/components/contentthinking.mdx +++ b/docs/models/components/contentthinking.mdx @@ -8,4 +8,4 @@ title: "ContentThinking" | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | `Signature` | `string` | :heavy_check_mark: | N/A | | `Thinking` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeThinking](../../models/components/typethinking.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeThinking](../../models/components/typethinking) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contenttoolreference.mdx b/docs/models/components/contenttoolreference.mdx index cee24863..8bb819fe 100644 --- a/docs/models/components/contenttoolreference.mdx +++ b/docs/models/components/contenttoolreference.mdx @@ -7,4 +7,4 @@ title: "ContentToolReference" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `ToolName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesMessageParamTypeToolReference](../../models/components/messagesmessageparamtypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.MessagesMessageParamTypeToolReference](../../models/components/messagesmessageparamtypetoolreference) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contenttoolresult.mdx b/docs/models/components/contenttoolresult.mdx index 13241baa..3fe6bef3 100644 --- a/docs/models/components/contenttoolresult.mdx +++ b/docs/models/components/contenttoolresult.mdx @@ -6,8 +6,8 @@ title: "ContentToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [*components.MessagesMessageParamContentUnion2](../../models/components/messagesmessageparamcontentunion2.mdx) | :heavy_minus_sign: | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [*components.MessagesMessageParamContentUnion2](../../models/components/messagesmessageparamcontentunion2) | :heavy_minus_sign: | N/A | | | `IsError` | `*bool` | :heavy_minus_sign: | N/A | | | `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeToolResult](../../models/components/typetoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.TypeToolResult](../../models/components/typetoolresult) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contenttooluse.mdx b/docs/models/components/contenttooluse.mdx index eb976304..94b4416d 100644 --- a/docs/models/components/contenttooluse.mdx +++ b/docs/models/components/contenttooluse.mdx @@ -6,8 +6,8 @@ title: "ContentToolUse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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"
} | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [components.TypeToolUse](../../models/components/typetooluse.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.TypeToolUse](../../models/components/typetooluse) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentwebsearchtoolresult.mdx b/docs/models/components/contentwebsearchtoolresult.mdx index b008e5b8..7461d72c 100644 --- a/docs/models/components/contentwebsearchtoolresult.mdx +++ b/docs/models/components/contentwebsearchtoolresult.mdx @@ -6,7 +6,7 @@ title: "ContentWebSearchToolResult" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [components.MessagesMessageParamContentUnion3](../../models/components/messagesmessageparamcontentunion3.mdx) | :heavy_check_mark: | N/A | | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [components.MessagesMessageParamContentUnion3](../../models/components/messagesmessageparamcontentunion3) | :heavy_check_mark: | N/A | | | `ToolUseID` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeWebSearchToolResult](../../models/components/typewebsearchtoolresult.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.TypeWebSearchToolResult](../../models/components/typewebsearchtoolresult) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contentwebsearchtoolresulterror.mdx b/docs/models/components/contentwebsearchtoolresulterror.mdx index 8abd9406..492e6c26 100644 --- a/docs/models/components/contentwebsearchtoolresulterror.mdx +++ b/docs/models/components/contentwebsearchtoolresulterror.mdx @@ -6,5 +6,5 @@ title: "ContentWebSearchToolResultError" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `ErrorCode` | [components.ErrorCode](../../models/components/errorcode.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.TypeWebSearchToolResultError](../../models/components/typewebsearchtoolresulterror.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ErrorCode` | [components.ErrorCode](../../models/components/errorcode) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeWebSearchToolResultError](../../models/components/typewebsearchtoolresulterror) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/contextcompactionitem.mdx b/docs/models/components/contextcompactionitem.mdx index 8ac1ee1c..25a622a1 100644 --- a/docs/models/components/contextcompactionitem.mdx +++ b/docs/models/components/contextcompactionitem.mdx @@ -11,5 +11,5 @@ A context compaction marker with an optional encrypted summary | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.ContextCompactionItemType](../../models/components/contextcompactionitemtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ContextCompactionItemType](../../models/components/contextcompactionitemtype) | :heavy_check_mark: | N/A | | | `AdditionalProperties` | map[string]`any` | :heavy_minus_sign: | N/A | \{
"encrypted_content": "enc_abc123...",
"type": "context_compaction"
} | \ No newline at end of file diff --git a/docs/models/components/contextcompressionplugin.mdx b/docs/models/components/contextcompressionplugin.mdx index 50c79da2..40fa8dd5 100644 --- a/docs/models/components/contextcompressionplugin.mdx +++ b/docs/models/components/contextcompressionplugin.mdx @@ -7,5 +7,5 @@ title: "ContextCompressionPlugin" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the context-compression plugin for this request. Defaults to true. | | -| `Engine` | [*components.ContextCompressionEngine](../../models/components/contextcompressionengine.mdx) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | -| `ID` | [components.ContextCompressionPluginID](../../models/components/contextcompressionpluginid.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Engine` | [*components.ContextCompressionEngine](../../models/components/contextcompressionengine) | :heavy_minus_sign: | The compression engine to use. Defaults to "middle-out". | middle-out | +| `ID` | [components.ContextCompressionPluginID](../../models/components/contextcompressionpluginid) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/contextmanagement.mdx b/docs/models/components/contextmanagement.mdx index be2538c0..93da54fe 100644 --- a/docs/models/components/contextmanagement.mdx +++ b/docs/models/components/contextmanagement.mdx @@ -6,4 +6,4 @@ title: "ContextManagement" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | -| `Edits` | [][components.Edit](../../models/components/edit.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Edits` | [][components.Edit](../../models/components/edit) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/contradiction.mdx b/docs/models/components/contradiction.mdx index eff1167c..3e9d88eb 100644 --- a/docs/models/components/contradiction.mdx +++ b/docs/models/components/contradiction.mdx @@ -6,5 +6,5 @@ title: "Contradiction" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `Stances` | [][components.Stance](../../models/components/stance.mdx) | :heavy_check_mark: | N/A | +| `Stances` | [][components.Stance](../../models/components/stance) | :heavy_check_mark: | N/A | | `Topic` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/createbyokkeyrequest.mdx b/docs/models/components/createbyokkeyrequest.mdx index 4652c4ce..2c8c5575 100644 --- a/docs/models/components/createbyokkeyrequest.mdx +++ b/docs/models/components/createbyokkeyrequest.mdx @@ -12,5 +12,5 @@ title: "CreateBYOKKeyRequest" | `IsFallback` | `*bool` | :heavy_minus_sign: | Whether this credential is treated as a fallback — used only after non-fallback keys for the same provider have been tried. | 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` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Optional human-readable name for the credential. | Production OpenAI Key | -| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug.mdx) | :heavy_check_mark: | The upstream provider this credential authenticates against, as a lowercase slug (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `Provider` | [components.BYOKProviderSlug](../../models/components/byokproviderslug) | :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. Defaults to the authenticated entity's default workspace. | 550e8400-e29b-41d4-a716-446655440000 | \ No newline at end of file diff --git a/docs/models/components/createbyokkeyresponse.mdx b/docs/models/components/createbyokkeyresponse.mdx index d2fd7088..5e97d7b4 100644 --- a/docs/models/components/createbyokkeyresponse.mdx +++ b/docs/models/components/createbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "CreateBYOKKeyResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.BYOKKey](../../models/components/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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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` | [components.BYOKKey](../../models/components/byokkey) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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/components/createguardrailrequest.mdx b/docs/models/components/createguardrailrequest.mdx index 560896b2..8da5190b 100644 --- a/docs/models/components/createguardrailrequest.mdx +++ b/docs/models/components/createguardrailrequest.mdx @@ -8,8 +8,8 @@ title: "CreateGuardrailRequest" | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AllowedModels` | optionalnullable.OptionalNullable[[]`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` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/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` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/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"
}
] | +| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput)] | :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` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry)] | :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` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Description of the guardrail | A guardrail for limiting API usage | | `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | | `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | @@ -25,5 +25,5 @@ title: "CreateGuardrailRequest" | `IncludeByokInBudgets` | `*bool` | :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` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Spending limit in USD | 50 | | `Name` | `string` | :heavy_check_mark: | Name for the new guardrail | My New Guardrail | -| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval)] | :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. Defaults to the default workspace if not provided. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/components/createguardrailresponse.mdx b/docs/models/components/createguardrailresponse.mdx index 7c08e4e3..f2cfdf94 100644 --- a/docs/models/components/createguardrailresponse.mdx +++ b/docs/models/components/createguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "CreateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"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` | [components.Guardrail](../../models/components/guardrail) | :heavy_check_mark: | N/A | \{
"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/components/createobservabilitydestinationrequest.mdx b/docs/models/components/createobservabilitydestinationrequest.mdx index 6bea6622..696f11db 100644 --- a/docs/models/components/createobservabilitydestinationrequest.mdx +++ b/docs/models/components/createobservabilitydestinationrequest.mdx @@ -9,9 +9,9 @@ title: "CreateObservabilityDestinationRequest" | `APIKeyHashes` | optionalnullable.OptionalNullable[[]`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 | | `Config` | map[string]`any` | :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` | `*bool` | :heavy_minus_sign: | Whether this destination should be enabled immediately. | true | -| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | :heavy_minus_sign: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable)] | :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` | `*bool` | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | | `SamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.CreateObservabilityDestinationRequestType](../../models/components/createobservabilitydestinationrequesttype.mdx) | :heavy_check_mark: | The destination type. Only stable destination types are accepted. | langfuse | +| `Type` | [components.CreateObservabilityDestinationRequestType](../../models/components/createobservabilitydestinationrequesttype) | :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 diff --git a/docs/models/components/createobservabilitydestinationresponse.mdx b/docs/models/components/createobservabilitydestinationresponse.mdx index ce3ec4b2..b132e809 100644 --- a/docs/models/components/createobservabilitydestinationresponse.mdx +++ b/docs/models/components/createobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "CreateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"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,
"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` | [components.ObservabilityDestination](../../models/components/observabilitydestination) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"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,
"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/components/createpresetfrominferenceresponse.mdx b/docs/models/components/createpresetfrominferenceresponse.mdx index 1dc095a8..107ce40b 100644 --- a/docs/models/components/createpresetfrominferenceresponse.mdx +++ b/docs/models/components/createpresetfrominferenceresponse.mdx @@ -9,4 +9,4 @@ Response containing the created preset with its designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.PresetWithDesignatedVersion](../../models/components/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` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion) | :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 diff --git a/docs/models/components/createworkspaceresponse.mdx b/docs/models/components/createworkspaceresponse.mdx index 57e3abd9..84404bb4 100644 --- a/docs/models/components/createworkspaceresponse.mdx +++ b/docs/models/components/createworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "CreateWorkspaceResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](../../models/components/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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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` | [components.Workspace](../../models/components/workspace) | :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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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/components/customtool.mdx b/docs/models/components/customtool.mdx index 54dc2380..a002f6ed 100644 --- a/docs/models/components/customtool.mdx +++ b/docs/models/components/customtool.mdx @@ -10,6 +10,6 @@ Custom tool configuration | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `Description` | `*string` | :heavy_minus_sign: | N/A | -| `Format` | [*components.Format](../../models/components/format.mdx) | :heavy_minus_sign: | N/A | +| `Format` | [*components.Format](../../models/components/format) | :heavy_minus_sign: | N/A | | `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.CustomToolTypeCustom](../../models/components/customtooltypecustom.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.CustomToolTypeCustom](../../models/components/customtooltypecustom) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcallinputdeltaevent.mdx b/docs/models/components/customtoolcallinputdeltaevent.mdx index 487e5397..064c325f 100644 --- a/docs/models/components/customtoolcallinputdeltaevent.mdx +++ b/docs/models/components/customtoolcallinputdeltaevent.mdx @@ -13,4 +13,4 @@ Event emitted when a custom tool call's freeform input is being streamed. Mirror | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.CustomToolCallInputDeltaEventType](../../models/components/customtoolcallinputdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.CustomToolCallInputDeltaEventType](../../models/components/customtoolcallinputdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcallinputdoneevent.mdx b/docs/models/components/customtoolcallinputdoneevent.mdx index dac6d4d8..f481e9ea 100644 --- a/docs/models/components/customtoolcallinputdoneevent.mdx +++ b/docs/models/components/customtoolcallinputdoneevent.mdx @@ -13,4 +13,4 @@ Event emitted when a custom tool call's freeform input streaming is complete. Mi | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.CustomToolCallInputDoneEventType](../../models/components/customtoolcallinputdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.CustomToolCallInputDoneEventType](../../models/components/customtoolcallinputdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcallitem.mdx b/docs/models/components/customtoolcallitem.mdx index 259a8600..7ad87479 100644 --- a/docs/models/components/customtoolcallitem.mdx +++ b/docs/models/components/customtoolcallitem.mdx @@ -14,4 +14,4 @@ A call to a custom (freeform-grammar) tool created by the model — distinct fro | `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` | [components.CustomToolCallItemType](../../models/components/customtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.CustomToolCallItemType](../../models/components/customtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcalloutputitem.mdx b/docs/models/components/customtoolcalloutputitem.mdx index 7ec0b9d3..e9b70aa7 100644 --- a/docs/models/components/customtoolcalloutputitem.mdx +++ b/docs/models/components/customtoolcalloutputitem.mdx @@ -11,5 +11,5 @@ The output from a custom (freeform-grammar) tool call execution. Mirrors `functi | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | | `CallID` | `string` | :heavy_check_mark: | N/A | | `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Output` | [components.CustomToolCallOutputItemOutputUnion2](../../models/components/customtoolcalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../../models/components/customtoolcalloutputitemtypecustomtoolcalloutput.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Output` | [components.CustomToolCallOutputItemOutputUnion2](../../models/components/customtoolcalloutputitemoutputunion2) | :heavy_check_mark: | N/A | +| `Type` | [components.CustomToolCallOutputItemTypeCustomToolCallOutput](../../models/components/customtoolcalloutputitemtypecustomtoolcalloutput) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx b/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx index 13a337f7..986cc227 100644 --- a/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx +++ b/docs/models/components/customtoolcalloutputitemoutputinputimage.mdx @@ -9,6 +9,6 @@ Image input content item | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `Detail` | [components.CustomToolCallOutputItemDetail](../../models/components/customtoolcalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | +| `Detail` | [components.CustomToolCallOutputItemDetail](../../models/components/customtoolcalloutputitemdetail) | :heavy_check_mark: | N/A | | `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.CustomToolCallOutputItemTypeInputImage](../../models/components/customtoolcalloutputitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.CustomToolCallOutputItemTypeInputImage](../../models/components/customtoolcalloutputitemtypeinputimage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/datetimeservertool.mdx b/docs/models/components/datetimeservertool.mdx index 221fe094..d63e023c 100644 --- a/docs/models/components/datetimeservertool.mdx +++ b/docs/models/components/datetimeservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: returns the current date and time | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.DatetimeServerToolConfig](../../models/components/datetimeservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | -| `Type` | [components.DatetimeServerToolType](../../models/components/datetimeservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.DatetimeServerToolConfig](../../models/components/datetimeservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:datetime server tool | \{
"timezone": "America/New_York"
} | +| `Type` | [components.DatetimeServerToolType](../../models/components/datetimeservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/debug.mdx b/docs/models/components/debug.mdx index d87cda21..2f59278e 100644 --- a/docs/models/components/debug.mdx +++ b/docs/models/components/debug.mdx @@ -7,4 +7,4 @@ title: "Debug" | Field | Type | Required | Description | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | | `EchoUpstreamBody` | map[string]`any` | :heavy_minus_sign: | N/A | -| `Timings` | [*components.Timings](../../models/components/timings.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Timings` | [*components.Timings](../../models/components/timings) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/debugevent.mdx b/docs/models/components/debugevent.mdx index 9f7bdcfc..e5346d0b 100644 --- a/docs/models/components/debugevent.mdx +++ b/docs/models/components/debugevent.mdx @@ -9,6 +9,6 @@ Debug event emitted when debug.echo_upstream_body is true. Contains the transfor | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Debug` | [components.Debug](../../models/components/debug.mdx) | :heavy_check_mark: | N/A | +| `Debug` | [components.Debug](../../models/components/debug) | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.DebugEventType](../../models/components/debugeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.DebugEventType](../../models/components/debugeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/easyinputmessage.mdx b/docs/models/components/easyinputmessage.mdx index 736d5df2..d6ed6a11 100644 --- a/docs/models/components/easyinputmessage.mdx +++ b/docs/models/components/easyinputmessage.mdx @@ -6,7 +6,7 @@ title: "EasyInputMessage" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[components.EasyInputMessageContentUnion2](../../models/components/easyinputmessagecontentunion2.mdx)] | :heavy_minus_sign: | N/A | | -| `Phase` | optionalnullable.OptionalNullable[[components.EasyInputMessagePhaseUnion](../../models/components/easyinputmessagephaseunion.mdx)] | :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` | [components.EasyInputMessageRoleUnion](../../models/components/easyinputmessageroleunion.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [*components.EasyInputMessageTypeMessage](../../models/components/easyinputmessagetypemessage.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Content` | optionalnullable.OptionalNullable[[components.EasyInputMessageContentUnion2](../../models/components/easyinputmessagecontentunion2)] | :heavy_minus_sign: | N/A | | +| `Phase` | optionalnullable.OptionalNullable[[components.EasyInputMessagePhaseUnion](../../models/components/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` | [components.EasyInputMessageRoleUnion](../../models/components/easyinputmessageroleunion) | :heavy_check_mark: | N/A | | +| `Type` | [*components.EasyInputMessageTypeMessage](../../models/components/easyinputmessagetypemessage) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/easyinputmessagecontentinputimage.mdx b/docs/models/components/easyinputmessagecontentinputimage.mdx index 96bcffb4..be53d5fd 100644 --- a/docs/models/components/easyinputmessagecontentinputimage.mdx +++ b/docs/models/components/easyinputmessagecontentinputimage.mdx @@ -9,6 +9,6 @@ Image input content item | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.EasyInputMessageDetail](../../models/components/easyinputmessagedetail.mdx) | :heavy_check_mark: | N/A | +| `Detail` | [components.EasyInputMessageDetail](../../models/components/easyinputmessagedetail) | :heavy_check_mark: | N/A | | `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.EasyInputMessageTypeInputImage](../../models/components/easyinputmessagetypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.EasyInputMessageTypeInputImage](../../models/components/easyinputmessagetypeinputimage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/editclearthinking20251015.mdx b/docs/models/components/editclearthinking20251015.mdx index fe22b8b8..ba10971b 100644 --- a/docs/models/components/editclearthinking20251015.mdx +++ b/docs/models/components/editclearthinking20251015.mdx @@ -6,5 +6,5 @@ title: "EditClearThinking20251015" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Keep` | [*components.Keep](../../models/components/keep.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeClearThinking20251015](../../models/components/typeclearthinking20251015.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Keep` | [*components.Keep](../../models/components/keep) | :heavy_minus_sign: | N/A | +| `Type` | [components.TypeClearThinking20251015](../../models/components/typeclearthinking20251015) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/editcleartooluses20250919.mdx b/docs/models/components/editcleartooluses20250919.mdx index c91abc41..817d91f1 100644 --- a/docs/models/components/editcleartooluses20250919.mdx +++ b/docs/models/components/editcleartooluses20250919.mdx @@ -6,9 +6,9 @@ title: "EditClearToolUses20250919" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ClearAtLeast` | optionalnullable.OptionalNullable[[components.AnthropicInputTokensClearAtLeast](../../models/components/anthropicinputtokensclearatleast.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 50000
} | -| `ClearToolInputs` | optionalnullable.OptionalNullable[[components.ClearToolInputs](../../models/components/cleartoolinputs.mdx)] | :heavy_minus_sign: | N/A | | +| `ClearAtLeast` | optionalnullable.OptionalNullable[[components.AnthropicInputTokensClearAtLeast](../../models/components/anthropicinputtokensclearatleast)] | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 50000
} | +| `ClearToolInputs` | optionalnullable.OptionalNullable[[components.ClearToolInputs](../../models/components/cleartoolinputs)] | :heavy_minus_sign: | N/A | | | `ExcludeTools` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `Keep` | [*components.AnthropicToolUsesKeep](../../models/components/anthropictooluseskeep.mdx) | :heavy_minus_sign: | N/A | \{
"type": "tool_uses",
"value": 5
} | -| `Trigger` | [*components.Trigger](../../models/components/trigger.mdx) | :heavy_minus_sign: | N/A | | -| `Type` | [components.TypeClearToolUses20250919](../../models/components/typecleartooluses20250919.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Keep` | [*components.AnthropicToolUsesKeep](../../models/components/anthropictooluseskeep) | :heavy_minus_sign: | N/A | \{
"type": "tool_uses",
"value": 5
} | +| `Trigger` | [*components.Trigger](../../models/components/trigger) | :heavy_minus_sign: | N/A | | +| `Type` | [components.TypeClearToolUses20250919](../../models/components/typecleartooluses20250919) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/editcompact20260112.mdx b/docs/models/components/editcompact20260112.mdx index c294056b..2bff8105 100644 --- a/docs/models/components/editcompact20260112.mdx +++ b/docs/models/components/editcompact20260112.mdx @@ -8,5 +8,5 @@ title: "EditCompact20260112" | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | `Instructions` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `PauseAfterCompaction` | `*bool` | :heavy_minus_sign: | N/A | | -| `Trigger` | optionalnullable.OptionalNullable[[components.TriggerInputTokens](../../models/components/triggerinputtokens.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 100000
} | -| `Type` | [components.TypeCompact20260112](../../models/components/typecompact20260112.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Trigger` | optionalnullable.OptionalNullable[[components.TriggerInputTokens](../../models/components/triggerinputtokens)] | :heavy_minus_sign: | N/A | \{
"type": "input_tokens",
"value": 100000
} | +| `Type` | [components.TypeCompact20260112](../../models/components/typecompact20260112) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/endpointsmetadata.mdx b/docs/models/components/endpointsmetadata.mdx index 68adcf3d..7f2bf25d 100644 --- a/docs/models/components/endpointsmetadata.mdx +++ b/docs/models/components/endpointsmetadata.mdx @@ -6,5 +6,5 @@ title: "EndpointsMetadata" | Field | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `Available` | [][components.EndpointInfo](../../models/components/endpointinfo.mdx) | :heavy_check_mark: | N/A | +| `Available` | [][components.EndpointInfo](../../models/components/endpointinfo) | :heavy_check_mark: | N/A | | `Total` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/enumcapability.mdx b/docs/models/components/enumcapability.mdx index 8948f387..cbc3a6d9 100644 --- a/docs/models/components/enumcapability.mdx +++ b/docs/models/components/enumcapability.mdx @@ -9,5 +9,5 @@ A parameter that accepts one of a discrete set of string values. | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `Type` | [components.EnumCapabilityType](../../models/components/enumcapabilitytype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.EnumCapabilityType](../../models/components/enumcapabilitytype) | :heavy_check_mark: | N/A | | `Values` | []`string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/errorevent.mdx b/docs/models/components/errorevent.mdx index 1d817e45..dc725410 100644 --- a/docs/models/components/errorevent.mdx +++ b/docs/models/components/errorevent.mdx @@ -13,4 +13,4 @@ Event emitted when an error occurs during streaming | `Message` | `string` | :heavy_check_mark: | N/A | | `Param` | `*string` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ErrorEventType](../../models/components/erroreventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ErrorEventType](../../models/components/erroreventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/filecitation.mdx b/docs/models/components/filecitation.mdx index 94c5664c..6d7c12ca 100644 --- a/docs/models/components/filecitation.mdx +++ b/docs/models/components/filecitation.mdx @@ -9,4 +9,4 @@ title: "FileCitation" | `FileID` | `string` | :heavy_check_mark: | N/A | | `Filename` | `string` | :heavy_check_mark: | N/A | | `Index` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FileCitationType](../../models/components/filecitationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FileCitationType](../../models/components/filecitationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fileparserplugin.mdx b/docs/models/components/fileparserplugin.mdx index bc1a76b3..307644f3 100644 --- a/docs/models/components/fileparserplugin.mdx +++ b/docs/models/components/fileparserplugin.mdx @@ -7,5 +7,5 @@ title: "FileParserPlugin" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the file-parser plugin for this request. Defaults to true. | | -| `ID` | [components.FileParserPluginID](../../models/components/fileparserpluginid.mdx) | :heavy_check_mark: | N/A | | -| `Pdf` | [*components.PDFParserOptions](../../models/components/pdfparseroptions.mdx) | :heavy_minus_sign: | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file +| `ID` | [components.FileParserPluginID](../../models/components/fileparserpluginid) | :heavy_check_mark: | N/A | | +| `Pdf` | [*components.PDFParserOptions](../../models/components/pdfparseroptions) | :heavy_minus_sign: | Options for PDF parsing. | \{
"engine": "cloudflare-ai"
} | \ No newline at end of file diff --git a/docs/models/components/filepath.mdx b/docs/models/components/filepath.mdx index f61c0fca..d2b078b6 100644 --- a/docs/models/components/filepath.mdx +++ b/docs/models/components/filepath.mdx @@ -8,4 +8,4 @@ title: "FilePath" | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | `FileID` | `string` | :heavy_check_mark: | N/A | | `Index` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FilePathType](../../models/components/filepathtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FilePathType](../../models/components/filepathtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/filesearchservertool.mdx b/docs/models/components/filesearchservertool.mdx index 43f1d7ae..35bc0303 100644 --- a/docs/models/components/filesearchservertool.mdx +++ b/docs/models/components/filesearchservertool.mdx @@ -9,8 +9,8 @@ File search tool configuration | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Filters` | optionalnullable.OptionalNullable[[components.FiltersUnion](../../models/components/filtersunion.mdx)] | :heavy_minus_sign: | N/A | +| `Filters` | optionalnullable.OptionalNullable[[components.FiltersUnion](../../models/components/filtersunion)] | :heavy_minus_sign: | N/A | | `MaxNumResults` | `*int64` | :heavy_minus_sign: | N/A | -| `RankingOptions` | [*components.RankingOptions](../../models/components/rankingoptions.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeFileSearch](../../models/components/typefilesearch.mdx) | :heavy_check_mark: | N/A | +| `RankingOptions` | [*components.RankingOptions](../../models/components/rankingoptions) | :heavy_minus_sign: | N/A | +| `Type` | [components.TypeFileSearch](../../models/components/typefilesearch) | :heavy_check_mark: | N/A | | `VectorStoreIds` | []`string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/filesservertool.mdx b/docs/models/components/filesservertool.mdx index 8dc641af..7337db27 100644 --- a/docs/models/components/filesservertool.mdx +++ b/docs/models/components/filesservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: read, write, edit, and list workspace files via | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `Parameters` | [*components.FilesServerToolConfig](../../models/components/filesservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:files server tool | \{} | -| `Type` | [components.FilesServerToolType](../../models/components/filesservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.FilesServerToolConfig](../../models/components/filesservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:files server tool | \{} | +| `Type` | [components.FilesServerToolType](../../models/components/filesservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/filters.mdx b/docs/models/components/filters.mdx index 60fea37e..88265a83 100644 --- a/docs/models/components/filters.mdx +++ b/docs/models/components/filters.mdx @@ -7,5 +7,5 @@ title: "Filters" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `Key` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.FiltersType](../../models/components/filterstype.mdx) | :heavy_check_mark: | N/A | -| `Value` | [components.FileSearchServerToolValue2](../../models/components/filesearchservertoolvalue2.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FiltersType](../../models/components/filterstype) | :heavy_check_mark: | N/A | +| `Value` | [components.FileSearchServerToolValue2](../../models/components/filesearchservertoolvalue2) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/formatgrammar.mdx b/docs/models/components/formatgrammar.mdx index 135667ed..8f09e46d 100644 --- a/docs/models/components/formatgrammar.mdx +++ b/docs/models/components/formatgrammar.mdx @@ -7,5 +7,5 @@ title: "FormatGrammar" | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `Definition` | `string` | :heavy_check_mark: | N/A | -| `Syntax` | [components.Syntax](../../models/components/syntax.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.FormatTypeGrammar](../../models/components/formattypegrammar.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Syntax` | [components.Syntax](../../models/components/syntax) | :heavy_check_mark: | N/A | +| `Type` | [components.FormatTypeGrammar](../../models/components/formattypegrammar) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/formatjsonobjectconfig.mdx b/docs/models/components/formatjsonobjectconfig.mdx index 9c1f2765..ee445ddc 100644 --- a/docs/models/components/formatjsonobjectconfig.mdx +++ b/docs/models/components/formatjsonobjectconfig.mdx @@ -9,4 +9,4 @@ JSON object response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Type` | [components.FormatJSONObjectConfigType](../../models/components/formatjsonobjectconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FormatJSONObjectConfigType](../../models/components/formatjsonobjectconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/formatjsonschemaconfig.mdx b/docs/models/components/formatjsonschemaconfig.mdx index 8fe262e3..b4770d23 100644 --- a/docs/models/components/formatjsonschemaconfig.mdx +++ b/docs/models/components/formatjsonschemaconfig.mdx @@ -13,4 +13,4 @@ JSON schema constrained response format | `Name` | `string` | :heavy_check_mark: | N/A | | `Schema` | map[string]`any` | :heavy_check_mark: | N/A | | `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | -| `Type` | [components.FormatJSONSchemaConfigType](../../models/components/formatjsonschemaconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FormatJSONSchemaConfigType](../../models/components/formatjsonschemaconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/formattext.mdx b/docs/models/components/formattext.mdx index 0fdb0030..406f8982 100644 --- a/docs/models/components/formattext.mdx +++ b/docs/models/components/formattext.mdx @@ -6,4 +6,4 @@ title: "FormatText" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Type` | [components.FormatTypeText](../../models/components/formattypetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FormatTypeText](../../models/components/formattypetext) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/formattextconfig.mdx b/docs/models/components/formattextconfig.mdx index 81c37e82..7c104b06 100644 --- a/docs/models/components/formattextconfig.mdx +++ b/docs/models/components/formattextconfig.mdx @@ -9,4 +9,4 @@ Plain text response format | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Type` | [components.FormatTextConfigType](../../models/components/formattextconfigtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FormatTextConfigType](../../models/components/formattextconfigtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/frameimage.mdx b/docs/models/components/frameimage.mdx index daccd1cb..4ed48b99 100644 --- a/docs/models/components/frameimage.mdx +++ b/docs/models/components/frameimage.mdx @@ -6,6 +6,6 @@ title: "FrameImage" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ImageURL` | [components.FrameImageImageURL](../../models/components/frameimageimageurl.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.FrameImageType](../../models/components/frameimagetype.mdx) | :heavy_check_mark: | N/A | | -| `FrameType` | [components.FrameType](../../models/components/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` | [components.FrameImageImageURL](../../models/components/frameimageimageurl) | :heavy_check_mark: | N/A | | +| `Type` | [components.FrameImageType](../../models/components/frameimagetype) | :heavy_check_mark: | N/A | | +| `FrameType` | [components.FrameType](../../models/components/frametype) | :heavy_check_mark: | 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/components/functioncallargsdeltaevent.mdx b/docs/models/components/functioncallargsdeltaevent.mdx index fe87ef02..06c4668c 100644 --- a/docs/models/components/functioncallargsdeltaevent.mdx +++ b/docs/models/components/functioncallargsdeltaevent.mdx @@ -13,4 +13,4 @@ Event emitted when function call arguments are being streamed | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FunctionCallArgsDeltaEventType](../../models/components/functioncallargsdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FunctionCallArgsDeltaEventType](../../models/components/functioncallargsdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/functioncallargsdoneevent.mdx b/docs/models/components/functioncallargsdoneevent.mdx index 73e403d8..2811c133 100644 --- a/docs/models/components/functioncallargsdoneevent.mdx +++ b/docs/models/components/functioncallargsdoneevent.mdx @@ -14,4 +14,4 @@ Event emitted when function call arguments streaming is complete | `Name` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FunctionCallArgsDoneEventType](../../models/components/functioncallargsdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FunctionCallArgsDoneEventType](../../models/components/functioncallargsdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/functioncallitem.mdx b/docs/models/components/functioncallitem.mdx index b40779e9..6c8bd9dc 100644 --- a/docs/models/components/functioncallitem.mdx +++ b/docs/models/components/functioncallitem.mdx @@ -14,5 +14,5 @@ A function call initiated by the model | `ID` | `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` | [*components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.FunctionCallItemType](../../models/components/functioncallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [*components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.FunctionCallItemType](../../models/components/functioncallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/functioncalloutputitem.mdx b/docs/models/components/functioncalloutputitem.mdx index 6260074c..6c055e41 100644 --- a/docs/models/components/functioncalloutputitem.mdx +++ b/docs/models/components/functioncalloutputitem.mdx @@ -11,6 +11,6 @@ The output from a function call execution | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `CallID` | `string` | :heavy_check_mark: | N/A | | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Output` | [components.FunctionCallOutputItemOutputUnion2](../../models/components/functioncalloutputitemoutputunion2.mdx) | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../../models/components/functioncalloutputitemtypefunctioncalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Output` | [components.FunctionCallOutputItemOutputUnion2](../../models/components/functioncalloutputitemoutputunion2) | :heavy_check_mark: | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.FunctionCallOutputItemTypeFunctionCallOutput](../../models/components/functioncalloutputitemtypefunctioncalloutput) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/functioncalloutputitemoutputinputimage.mdx b/docs/models/components/functioncalloutputitemoutputinputimage.mdx index 4f31b6aa..921ead3a 100644 --- a/docs/models/components/functioncalloutputitemoutputinputimage.mdx +++ b/docs/models/components/functioncalloutputitemoutputinputimage.mdx @@ -9,6 +9,6 @@ Image input content item | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.FunctionCallOutputItemDetail](../../models/components/functioncalloutputitemdetail.mdx) | :heavy_check_mark: | N/A | +| `Detail` | [components.FunctionCallOutputItemDetail](../../models/components/functioncalloutputitemdetail) | :heavy_check_mark: | N/A | | `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.FunctionCallOutputItemTypeInputImage](../../models/components/functioncalloutputitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FunctionCallOutputItemTypeInputImage](../../models/components/functioncalloutputitemtypeinputimage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusionanalysisresult.mdx b/docs/models/components/fusionanalysisresult.mdx index 2b8574ff..d77bcead 100644 --- a/docs/models/components/fusionanalysisresult.mdx +++ b/docs/models/components/fusionanalysisresult.mdx @@ -11,6 +11,6 @@ Structured analysis produced by the fusion analyst model. | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `BlindSpots` | []`string` | :heavy_check_mark: | N/A | | `Consensus` | []`string` | :heavy_check_mark: | N/A | -| `Contradictions` | [][components.Contradiction](../../models/components/contradiction.mdx) | :heavy_check_mark: | N/A | -| `PartialCoverage` | [][components.PartialCoverage](../../models/components/partialcoverage.mdx) | :heavy_check_mark: | N/A | -| `UniqueInsights` | [][components.UniqueInsight](../../models/components/uniqueinsight.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Contradictions` | [][components.Contradiction](../../models/components/contradiction) | :heavy_check_mark: | N/A | +| `PartialCoverage` | [][components.PartialCoverage](../../models/components/partialcoverage) | :heavy_check_mark: | N/A | +| `UniqueInsights` | [][components.UniqueInsight](../../models/components/uniqueinsight) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallanalysiscompletedevent.mdx b/docs/models/components/fusioncallanalysiscompletedevent.mdx index 1bccc6e8..f45ecb7b 100644 --- a/docs/models/components/fusioncallanalysiscompletedevent.mdx +++ b/docs/models/components/fusioncallanalysiscompletedevent.mdx @@ -9,8 +9,8 @@ Emitted when the fusion analyst completes with the structured analysis. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Analysis` | [components.FusionAnalysisResult](../../models/components/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"
}
]
} | +| `Analysis` | [components.FusionAnalysisResult](../../models/components/fusionanalysisresult) | :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` | `int64` | :heavy_check_mark: | N/A | | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.FusionCallAnalysisCompletedEventType](../../models/components/fusioncallanalysiscompletedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.FusionCallAnalysisCompletedEventType](../../models/components/fusioncallanalysiscompletedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/fusioncallanalysisinprogressevent.mdx b/docs/models/components/fusioncallanalysisinprogressevent.mdx index 4a41b40f..59d609df 100644 --- a/docs/models/components/fusioncallanalysisinprogressevent.mdx +++ b/docs/models/components/fusioncallanalysisinprogressevent.mdx @@ -14,4 +14,4 @@ Emitted when the fusion analyst starts producing the structured analysis. | ~~`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` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallAnalysisInProgressEventType](../../models/components/fusioncallanalysisinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FusionCallAnalysisInProgressEventType](../../models/components/fusioncallanalysisinprogresseventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallcompletedevent.mdx b/docs/models/components/fusioncallcompletedevent.mdx index ade9c1d7..2ff46cbd 100644 --- a/docs/models/components/fusioncallcompletedevent.mdx +++ b/docs/models/components/fusioncallcompletedevent.mdx @@ -12,4 +12,4 @@ Emitted when the openrouter:fusion tool call finishes. | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallCompletedEventType](../../models/components/fusioncallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FusionCallCompletedEventType](../../models/components/fusioncallcompletedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallinprogressevent.mdx b/docs/models/components/fusioncallinprogressevent.mdx index 22884b2a..1b14201a 100644 --- a/docs/models/components/fusioncallinprogressevent.mdx +++ b/docs/models/components/fusioncallinprogressevent.mdx @@ -12,4 +12,4 @@ Emitted when an openrouter:fusion tool call begins executing. | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallInProgressEventType](../../models/components/fusioncallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FusionCallInProgressEventType](../../models/components/fusioncallinprogresseventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpaneladdedevent.mdx b/docs/models/components/fusioncallpaneladdedevent.mdx index 08d12147..040d2103 100644 --- a/docs/models/components/fusioncallpaneladdedevent.mdx +++ b/docs/models/components/fusioncallpaneladdedevent.mdx @@ -13,4 +13,4 @@ Emitted when a fusion analysis-panel model starts. | `Model` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallPanelAddedEventType](../../models/components/fusioncallpaneladdedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FusionCallPanelAddedEventType](../../models/components/fusioncallpaneladdedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpanelcompletedevent.mdx b/docs/models/components/fusioncallpanelcompletedevent.mdx index 8b41b367..bd52f3ea 100644 --- a/docs/models/components/fusioncallpanelcompletedevent.mdx +++ b/docs/models/components/fusioncallpanelcompletedevent.mdx @@ -14,4 +14,4 @@ Emitted when a fusion panel model finishes with its full content. | `Model` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallPanelCompletedEventType](../../models/components/fusioncallpanelcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FusionCallPanelCompletedEventType](../../models/components/fusioncallpanelcompletedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpaneldeltaevent.mdx b/docs/models/components/fusioncallpaneldeltaevent.mdx index 7bfa29b8..7b9ef15a 100644 --- a/docs/models/components/fusioncallpaneldeltaevent.mdx +++ b/docs/models/components/fusioncallpaneldeltaevent.mdx @@ -14,4 +14,4 @@ Incremental content token from a fusion panel model. | `Model` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallPanelDeltaEventType](../../models/components/fusioncallpaneldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FusionCallPanelDeltaEventType](../../models/components/fusioncallpaneldeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpanelfailedevent.mdx b/docs/models/components/fusioncallpanelfailedevent.mdx index 0c0a4544..f8693883 100644 --- a/docs/models/components/fusioncallpanelfailedevent.mdx +++ b/docs/models/components/fusioncallpanelfailedevent.mdx @@ -15,4 +15,4 @@ Emitted when a fusion panel model fails. | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | `StatusCode` | `*int64` | :heavy_minus_sign: | N/A | -| `Type` | [components.FusionCallPanelFailedEventType](../../models/components/fusioncallpanelfailedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FusionCallPanelFailedEventType](../../models/components/fusioncallpanelfailedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx b/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx index 6f9e454f..a01cef47 100644 --- a/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx +++ b/docs/models/components/fusioncallpanelreasoningdeltaevent.mdx @@ -14,4 +14,4 @@ Incremental reasoning token from a fusion panel model. | `Model` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.FusionCallPanelReasoningDeltaEventType](../../models/components/fusioncallpanelreasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.FusionCallPanelReasoningDeltaEventType](../../models/components/fusioncallpanelreasoningdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/fusionplugin.mdx b/docs/models/components/fusionplugin.mdx index c8234cc9..93c8ae99 100644 --- a/docs/models/components/fusionplugin.mdx +++ b/docs/models/components/fusionplugin.mdx @@ -8,8 +8,8 @@ title: "FusionPlugin" | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `AnalysisModels` | []`string` | :heavy_minus_sign: | 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-latest, ~google/gemini-pro-latest). | [
"~anthropic/claude-opus-latest",
"~openai/gpt-latest",
"~google/gemini-pro-latest"
] | | `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the fusion plugin for this request. Defaults to true. | | -| `ID` | [components.FusionPluginID](../../models/components/fusionpluginid.mdx) | :heavy_check_mark: | N/A | | +| `ID` | [components.FusionPluginID](../../models/components/fusionpluginid) | :heavy_check_mark: | N/A | | | `MaxToolCalls` | `*int64` | :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 8. Capped at 16. | 12 | | `Model` | `*string` | :heavy_minus_sign: | 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` | [*components.PresetEnum](../../models/components/presetenum.mdx) | :heavy_minus_sign: | A curated OpenRouter fusion 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` | [][components.FusionPluginTool](../../models/components/fusionplugintool.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 +| `Preset` | [*components.PresetEnum](../../models/components/presetenum) | :heavy_minus_sign: | A curated OpenRouter fusion 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` | [][components.FusionPluginTool](../../models/components/fusionplugintool) | :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 diff --git a/docs/models/components/fusionplugintool.mdx b/docs/models/components/fusionplugintool.mdx index 22492136..ee1d472f 100644 --- a/docs/models/components/fusionplugintool.mdx +++ b/docs/models/components/fusionplugintool.mdx @@ -6,5 +6,5 @@ title: "FusionPluginTool" | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `Parameters` | map[string][*components.Parameters3](../../models/components/parameters3.mdx) | :heavy_minus_sign: | Optional configuration forwarded as the tool's `parameters` object. | +| `Parameters` | map[string][*components.Parameters3](../../models/components/parameters3) | :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 diff --git a/docs/models/components/fusionservertoolconfig.mdx b/docs/models/components/fusionservertoolconfig.mdx index 3d3b8ed1..f03853a9 100644 --- a/docs/models/components/fusionservertoolconfig.mdx +++ b/docs/models/components/fusionservertoolconfig.mdx @@ -10,10 +10,10 @@ Configuration for the openrouter:fusion server tool. | 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-latest",
"~google/gemini-pro-latest"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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"
} | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | `*int64` | :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. When omitted, panelists default to 32000 and the analyst to 20000. | 16384 | | `MaxToolCalls` | `*int64` | :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 8. 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` | [*components.FusionServerToolConfigReasoning](../../models/components/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. | | +| `Reasoning` | [*components.FusionServerToolConfigReasoning](../../models/components/fusionservertoolconfigreasoning) | :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` | `*float64` | :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` | [][components.FusionServerToolConfigTool](../../models/components/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 +| `Tools` | [][components.FusionServerToolConfigTool](../../models/components/fusionservertoolconfigtool) | :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 diff --git a/docs/models/components/fusionservertoolconfigreasoning.mdx b/docs/models/components/fusionservertoolconfigreasoning.mdx index 5f5a7eed..9e80d73e 100644 --- a/docs/models/components/fusionservertoolconfigreasoning.mdx +++ b/docs/models/components/fusionservertoolconfigreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to panelist and analyst inner calls. Use this | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Effort` | [*components.FusionServerToolConfigEffort](../../models/components/fusionservertoolconfigeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for panelist and analyst inner calls. | +| `Effort` | [*components.FusionServerToolConfigEffort](../../models/components/fusionservertoolconfigeffort) | :heavy_minus_sign: | Reasoning effort level for panelist and analyst inner calls. | | `MaxTokens` | `*int64` | :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 diff --git a/docs/models/components/fusionservertoolopenrouter.mdx b/docs/models/components/fusionservertoolopenrouter.mdx index 94a5481b..8d74d599 100644 --- a/docs/models/components/fusionservertoolopenrouter.mdx +++ b/docs/models/components/fusionservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: fans out the user prompt to a panel of analysis | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.FusionServerToolConfig](../../models/components/fusionservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-latest",
"~google/gemini-pro-latest"
]
} | -| `Type` | [components.FusionServerToolOpenRouterType](../../models/components/fusionservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.FusionServerToolConfig](../../models/components/fusionservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:fusion server tool. | \{
"analysis_models": [
"~anthropic/claude-opus-latest",
"~openai/gpt-latest",
"~google/gemini-pro-latest"
]
} | +| `Type` | [components.FusionServerToolOpenRouterType](../../models/components/fusionservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/generationcontentdata.mdx b/docs/models/components/generationcontentdata.mdx index a2f0ddbb..3ef81149 100644 --- a/docs/models/components/generationcontentdata.mdx +++ b/docs/models/components/generationcontentdata.mdx @@ -9,5 +9,5 @@ Stored prompt and completion content | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Input` | [components.InputUnion](../../models/components/inputunion.mdx) | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | -| `Output` | [components.GenerationContentDataOutput](../../models/components/generationcontentdataoutput.mdx) | :heavy_check_mark: | The output from the generation | \ No newline at end of file +| `Input` | [components.InputUnion](../../models/components/inputunion) | :heavy_check_mark: | The input to the generation — either a prompt string or an array of messages | +| `Output` | [components.GenerationContentDataOutput](../../models/components/generationcontentdataoutput) | :heavy_check_mark: | The output from the generation | \ No newline at end of file diff --git a/docs/models/components/generationcontentresponse.mdx b/docs/models/components/generationcontentresponse.mdx index 2a317216..be5193d7 100644 --- a/docs/models/components/generationcontentresponse.mdx +++ b/docs/models/components/generationcontentresponse.mdx @@ -9,4 +9,4 @@ Stored prompt and completion content for a generation | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.GenerationContentData](../../models/components/generationcontentdata.mdx) | :heavy_check_mark: | Stored prompt and completion content | \{
"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` | [components.GenerationContentData](../../models/components/generationcontentdata) | :heavy_check_mark: | Stored prompt and completion content | \{
"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/components/generationresponse.mdx b/docs/models/components/generationresponse.mdx index 11f8aa4d..97485188 100644 --- a/docs/models/components/generationresponse.mdx +++ b/docs/models/components/generationresponse.mdx @@ -9,4 +9,4 @@ Generation response | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Data` | [components.GenerationResponseData](../../models/components/generationresponsedata.mdx) | :heavy_check_mark: | Generation data | \ No newline at end of file +| `Data` | [components.GenerationResponseData](../../models/components/generationresponsedata) | :heavy_check_mark: | Generation data | \ No newline at end of file diff --git a/docs/models/components/generationresponsedata.mdx b/docs/models/components/generationresponsedata.mdx index 4ba70f94..b9f73553 100644 --- a/docs/models/components/generationresponsedata.mdx +++ b/docs/models/components/generationresponsedata.mdx @@ -9,12 +9,12 @@ Generation data | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `APIType` | [*components.APIType](../../models/components/apitype.mdx) | :heavy_check_mark: | Type of API used for the generation | | +| `APIType` | [*components.APIType](../../models/components/apitype) | :heavy_check_mark: | Type of API used for the generation | | | `AppID` | `*int64` | :heavy_check_mark: | ID of the app that made the request | 12345 | | `CacheDiscount` | `*float64` | :heavy_check_mark: | Discount applied due to caching | 0.0002 | | `Cancelled` | `*bool` | :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` | [components.DataRegion](../../models/components/dataregion.mdx) | :heavy_check_mark: | The data region this generation was routed through: 'global', 'europe', or 'us'. | global | +| `DataRegion` | [components.DataRegion](../../models/components/dataregion) | :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` | `*float64` | :heavy_check_mark: | Time taken for generation in milliseconds | 1200 | @@ -38,7 +38,7 @@ Generation data | `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` | [][components.ProviderResponse](../../models/components/providerresponse.mdx) | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | +| `ProviderResponses` | [][components.ProviderResponse](../../models/components/providerresponse) | :heavy_check_mark: | List of provider responses for this generation, including fallback attempts | | | `RequestID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Unique identifier grouping all generations from a single API request | req-1727282430-aBcDeFgHiJkLmNoPqRsT | | `ResponseCacheSourceID` | optionalnullable.OptionalNullable[`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 | diff --git a/docs/models/components/getbyokkeyresponse.mdx b/docs/models/components/getbyokkeyresponse.mdx index 3f442cf9..f2ade1ff 100644 --- a/docs/models/components/getbyokkeyresponse.mdx +++ b/docs/models/components/getbyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "GetBYOKKeyResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.BYOKKey](../../models/components/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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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` | [components.BYOKKey](../../models/components/byokkey) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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/components/getguardrailresponse.mdx b/docs/models/components/getguardrailresponse.mdx index b8732764..5570d837 100644 --- a/docs/models/components/getguardrailresponse.mdx +++ b/docs/models/components/getguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "GetGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"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` | [components.Guardrail](../../models/components/guardrail) | :heavy_check_mark: | N/A | \{
"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/components/getobservabilitydestinationresponse.mdx b/docs/models/components/getobservabilitydestinationresponse.mdx index bde620ba..d53acde6 100644 --- a/docs/models/components/getobservabilitydestinationresponse.mdx +++ b/docs/models/components/getobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "GetObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"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,
"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` | [components.ObservabilityDestination](../../models/components/observabilitydestination) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"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,
"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/components/getpresetresponse.mdx b/docs/models/components/getpresetresponse.mdx index 25f1369c..9f8af683 100644 --- a/docs/models/components/getpresetresponse.mdx +++ b/docs/models/components/getpresetresponse.mdx @@ -9,4 +9,4 @@ A preset with its currently designated version. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.PresetWithDesignatedVersion](../../models/components/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` | [components.PresetWithDesignatedVersion](../../models/components/presetwithdesignatedversion) | :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 diff --git a/docs/models/components/getpresetversionresponse.mdx b/docs/models/components/getpresetversionresponse.mdx index 522921fc..f82366e6 100644 --- a/docs/models/components/getpresetversionresponse.mdx +++ b/docs/models/components/getpresetversionresponse.mdx @@ -9,4 +9,4 @@ A single version of a preset. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [*components.PresetDesignatedVersion](../../models/components/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` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion) | :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 diff --git a/docs/models/components/getworkspaceresponse.mdx b/docs/models/components/getworkspaceresponse.mdx index 02369de3..1df937aa 100644 --- a/docs/models/components/getworkspaceresponse.mdx +++ b/docs/models/components/getworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "GetWorkspaceResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](../../models/components/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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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` | [components.Workspace](../../models/components/workspace) | :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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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/components/guardrail.mdx b/docs/models/components/guardrail.mdx index 94b14911..bafe1976 100644 --- a/docs/models/components/guardrail.mdx +++ b/docs/models/components/guardrail.mdx @@ -8,8 +8,8 @@ title: "Guardrail" | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AllowedModels` | optionalnullable.OptionalNullable[[]`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` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | List of allowed provider IDs | [
"openai",
"anthropic",
"google"
] | -| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntry](../../models/components/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` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/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"
}
] | +| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntry](../../models/components/contentfilterbuiltinentry)] | :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` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry)] | :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` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | Description of the guardrail | Guardrail for production environment | | `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | @@ -27,6 +27,6 @@ title: "Guardrail" | `IncludeByokInBudgets` | `bool` | :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` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Spending limit in USD | 100 | | `Name` | `string` | :heavy_check_mark: | Name of the guardrail | Production Guardrail | -| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | +| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | | `UpdatedAt` | optionalnullable.OptionalNullable[`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 ID this guardrail belongs to. | 0df9e665-d932-5740-b2c7-b52af166bc11 | \ No newline at end of file diff --git a/docs/models/components/imageendpoint.mdx b/docs/models/components/imageendpoint.mdx index c0edb162..bb3daa81 100644 --- a/docs/models/components/imageendpoint.mdx +++ b/docs/models/components/imageendpoint.mdx @@ -10,9 +10,9 @@ An endpoint that serves a given image model. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AllowedPassthroughParameters` | []`string` | :heavy_check_mark: | Provider-specific options accepted under provider.options[provider_slug]. | [] | -| `Pricing` | [][components.ImagePricingEntry](../../models/components/imagepricingentry.mdx) | :heavy_check_mark: | Billable pricing lines for this endpoint. | [
\{
"billable": "output_image",
"cost_usd": 0.05,
"unit": "image"
}
] | +| `Pricing` | [][components.ImagePricingEntry](../../models/components/imagepricingentry) | :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` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | :heavy_check_mark: | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | +| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor) | :heavy_check_mark: | N/A | \{
"output_compression": \{
"max": 100,
"min": 0,
"type": "range"
},
"resolution": \{
"type": "enum",
"values": [
"1K",
"2K",
"4K"
]
},
"seed": \{
"type": "boolean"
}
} | | `SupportsStreaming` | `bool` | :heavy_check_mark: | Whether this endpoint supports native SSE streaming (`stream: true` in the request). | false | \ No newline at end of file diff --git a/docs/models/components/imagegencallcompletedevent.mdx b/docs/models/components/imagegencallcompletedevent.mdx index c889cb29..b3028f11 100644 --- a/docs/models/components/imagegencallcompletedevent.mdx +++ b/docs/models/components/imagegencallcompletedevent.mdx @@ -12,4 +12,4 @@ Image generation call completed | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallCompletedEventType](../../models/components/imagegencallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ImageGenCallCompletedEventType](../../models/components/imagegencallcompletedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencallgeneratingevent.mdx b/docs/models/components/imagegencallgeneratingevent.mdx index 5d6441a8..09bf565f 100644 --- a/docs/models/components/imagegencallgeneratingevent.mdx +++ b/docs/models/components/imagegencallgeneratingevent.mdx @@ -12,4 +12,4 @@ Image generation call is generating | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallGeneratingEventType](../../models/components/imagegencallgeneratingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ImageGenCallGeneratingEventType](../../models/components/imagegencallgeneratingeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencallinprogressevent.mdx b/docs/models/components/imagegencallinprogressevent.mdx index 9de51b34..d07e8424 100644 --- a/docs/models/components/imagegencallinprogressevent.mdx +++ b/docs/models/components/imagegencallinprogressevent.mdx @@ -12,4 +12,4 @@ Image generation call in progress | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallInProgressEventType](../../models/components/imagegencallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ImageGenCallInProgressEventType](../../models/components/imagegencallinprogresseventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencallpartialimageevent.mdx b/docs/models/components/imagegencallpartialimageevent.mdx index bb25583f..f5134029 100644 --- a/docs/models/components/imagegencallpartialimageevent.mdx +++ b/docs/models/components/imagegencallpartialimageevent.mdx @@ -14,4 +14,4 @@ Image generation call with partial image | `PartialImageB64` | `string` | :heavy_check_mark: | N/A | | `PartialImageIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ImageGenCallPartialImageEventType](../../models/components/imagegencallpartialimageeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ImageGenCallPartialImageEventType](../../models/components/imagegencallpartialimageeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegencompletedevent.mdx b/docs/models/components/imagegencompletedevent.mdx index a7420ac7..27a3dd87 100644 --- a/docs/models/components/imagegencompletedevent.mdx +++ b/docs/models/components/imagegencompletedevent.mdx @@ -12,5 +12,5 @@ Emitted when generation completes and the final image is available | `B64JSON` | `string` | :heavy_check_mark: | Base64-encoded final image data | | | `Created` | `int64` | :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` | [components.ImageGenCompletedEventType](../../models/components/imagegencompletedeventtype.mdx) | :heavy_check_mark: | The event type | | -| `Usage` | [*components.ImageGenerationUsage](../../models/components/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 +| `Type` | [components.ImageGenCompletedEventType](../../models/components/imagegencompletedeventtype) | :heavy_check_mark: | The event type | | +| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage) | :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 diff --git a/docs/models/components/imagegenerationproviderpreferences.mdx b/docs/models/components/imagegenerationproviderpreferences.mdx index 5fe499ab..40386117 100644 --- a/docs/models/components/imagegenerationproviderpreferences.mdx +++ b/docs/models/components/imagegenerationproviderpreferences.mdx @@ -10,8 +10,8 @@ Provider routing preferences and provider-specific passthrough configuration. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | :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` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesIgnore](../../models/components/imagegenerationproviderpreferencesignore.mdx)] | :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` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOnly](../../models/components/imagegenerationproviderpreferencesonly.mdx)] | :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` | [*components.ImageGenerationProviderPreferencesOptions](../../models/components/imagegenerationproviderpreferencesoptions.mdx) | :heavy_minus_sign: | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | -| `Order` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOrder](../../models/components/imagegenerationproviderpreferencesorder.mdx)] | :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` | optionalnullable.OptionalNullable[[components.ImageGenerationProviderPreferencesSort](../../models/components/imagegenerationproviderpreferencessort.mdx)] | :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 +| `Ignore` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesIgnore](../../models/components/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` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOnly](../../models/components/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` | [*components.ImageGenerationProviderPreferencesOptions](../../models/components/imagegenerationproviderpreferencesoptions) | :heavy_minus_sign: | N/A | \{
"black-forest-labs": \{
"guidance": 3,
"steps": 40
}
} | +| `Order` | optionalnullable.OptionalNullable[[][components.ImageGenerationProviderPreferencesOrder](../../models/components/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` | optionalnullable.OptionalNullable[[components.ImageGenerationProviderPreferencesSort](../../models/components/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 diff --git a/docs/models/components/imagegenerationrequest.mdx b/docs/models/components/imagegenerationrequest.mdx index fd326e2e..9cc8edf8 100644 --- a/docs/models/components/imagegenerationrequest.mdx +++ b/docs/models/components/imagegenerationrequest.mdx @@ -9,17 +9,17 @@ Image generation request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AspectRatio` | [*components.ImageGenerationRequestAspectRatio](../../models/components/imagegenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | -| `Background` | [*components.ImageGenerationRequestBackground](../../models/components/imagegenerationrequestbackground.mdx) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | -| `InputReferences` | [][components.ContentPartImage](../../models/components/contentpartimage.mdx) | :heavy_minus_sign: | Reference images to guide image-to-image generation, as base64 data URLs or HTTP(S) URLs. | | +| `AspectRatio` | [*components.ImageGenerationRequestAspectRatio](../../models/components/imagegenerationrequestaspectratio) | :heavy_minus_sign: | Normalized aspect ratio of the generated image. Providers clamp to their supported subset. | 16:9 | +| `Background` | [*components.ImageGenerationRequestBackground](../../models/components/imagegenerationrequestbackground) | :heavy_minus_sign: | Background treatment. `transparent` requires an output_format that supports alpha (png or webp). | auto | +| `InputReferences` | [][components.ContentPartImage](../../models/components/contentpartimage) | :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` | `*int64` | :heavy_minus_sign: | Number of images to generate (1-10). Providers that only support single-image generation reject n > 1. | 1 | | `OutputCompression` | `*int64` | :heavy_minus_sign: | Compression level (0-100) for webp/jpeg output. Ignored for png and by providers without a compression knob. | 100 | -| `OutputFormat` | [*components.ImageGenerationRequestOutputFormat](../../models/components/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 | +| `OutputFormat` | [*components.ImageGenerationRequestOutputFormat](../../models/components/imagegenerationrequestoutputformat) | :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` | [*components.ImageGenerationProviderPreferences](../../models/components/imagegenerationproviderpreferences.mdx) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | -| `Quality` | [*components.ImageGenerationRequestQuality](../../models/components/imagegenerationrequestquality.mdx) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | -| `Resolution` | [*components.ImageGenerationRequestResolution](../../models/components/imagegenerationrequestresolution.mdx) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | +| `Provider` | [*components.ImageGenerationProviderPreferences](../../models/components/imagegenerationproviderpreferences) | :heavy_minus_sign: | Provider routing preferences and provider-specific passthrough configuration. | \{
"allow_fallbacks": false,
"only": [
"google-ai-studio"
]
} | +| `Quality` | [*components.ImageGenerationRequestQuality](../../models/components/imagegenerationrequestquality) | :heavy_minus_sign: | Rendering quality. Providers without a quality knob ignore this. | high | +| `Resolution` | [*components.ImageGenerationRequestResolution](../../models/components/imagegenerationrequestresolution) | :heavy_minus_sign: | Normalized resolution tier of the generated image. Concrete pixel dimensions are derived per-provider. | 2K | | `Seed` | `*int64` | :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. | | | `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` | `*bool` | :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. | | \ No newline at end of file diff --git a/docs/models/components/imagegenerationresponse.mdx b/docs/models/components/imagegenerationresponse.mdx index 647efd06..756e0bff 100644 --- a/docs/models/components/imagegenerationresponse.mdx +++ b/docs/models/components/imagegenerationresponse.mdx @@ -10,5 +10,5 @@ Image generation response | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `Created` | `int64` | :heavy_check_mark: | Unix timestamp (seconds) when the image was generated | 1748372400 | -| `Data` | [][components.ImageGenerationResponseData](../../models/components/imagegenerationresponsedata.mdx) | :heavy_check_mark: | Generated images | | -| `Usage` | [*components.ImageGenerationUsage](../../models/components/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 +| `Data` | [][components.ImageGenerationResponseData](../../models/components/imagegenerationresponsedata) | :heavy_check_mark: | Generated images | | +| `Usage` | [*components.ImageGenerationUsage](../../models/components/imagegenerationusage) | :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 diff --git a/docs/models/components/imagegenerationservertool.mdx b/docs/models/components/imagegenerationservertool.mdx index c24479a3..5e0e91ac 100644 --- a/docs/models/components/imagegenerationservertool.mdx +++ b/docs/models/components/imagegenerationservertool.mdx @@ -9,14 +9,14 @@ Image generation tool configuration | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `Background` | [*components.ImageGenerationServerToolBackground](../../models/components/imagegenerationservertoolbackground.mdx) | :heavy_minus_sign: | N/A | -| `InputFidelity` | optionalnullable.OptionalNullable[[components.InputFidelity](../../models/components/inputfidelity.mdx)] | :heavy_minus_sign: | N/A | -| `InputImageMask` | [*components.InputImageMask](../../models/components/inputimagemask.mdx) | :heavy_minus_sign: | N/A | +| `Background` | [*components.ImageGenerationServerToolBackground](../../models/components/imagegenerationservertoolbackground) | :heavy_minus_sign: | N/A | +| `InputFidelity` | optionalnullable.OptionalNullable[[components.InputFidelity](../../models/components/inputfidelity)] | :heavy_minus_sign: | N/A | +| `InputImageMask` | [*components.InputImageMask](../../models/components/inputimagemask) | :heavy_minus_sign: | N/A | | `Model` | `*string` | :heavy_minus_sign: | N/A | -| `Moderation` | [*components.Moderation](../../models/components/moderation.mdx) | :heavy_minus_sign: | N/A | +| `Moderation` | [*components.Moderation](../../models/components/moderation) | :heavy_minus_sign: | N/A | | `OutputCompression` | `*int64` | :heavy_minus_sign: | N/A | -| `OutputFormat` | [*components.ImageGenerationServerToolOutputFormat](../../models/components/imagegenerationservertooloutputformat.mdx) | :heavy_minus_sign: | N/A | +| `OutputFormat` | [*components.ImageGenerationServerToolOutputFormat](../../models/components/imagegenerationservertooloutputformat) | :heavy_minus_sign: | N/A | | `PartialImages` | `*int64` | :heavy_minus_sign: | N/A | -| `Quality` | [*components.ImageGenerationServerToolQuality](../../models/components/imagegenerationservertoolquality.mdx) | :heavy_minus_sign: | N/A | +| `Quality` | [*components.ImageGenerationServerToolQuality](../../models/components/imagegenerationservertoolquality) | :heavy_minus_sign: | N/A | | `Size` | `*string` | :heavy_minus_sign: | N/A | -| `Type` | [components.ImageGenerationServerToolType](../../models/components/imagegenerationservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ImageGenerationServerToolType](../../models/components/imagegenerationservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagegenerationservertoolconfig.mdx b/docs/models/components/imagegenerationservertoolconfig.mdx index 62883b6d..d6aa0bc8 100644 --- a/docs/models/components/imagegenerationservertoolconfig.mdx +++ b/docs/models/components/imagegenerationservertoolconfig.mdx @@ -10,4 +10,4 @@ Configuration for the openrouter:image_generation server tool. Accepts all image | 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` | map[string][components.ImageGenerationServerToolConfigUnion](../../models/components/imagegenerationservertoolconfigunion.mdx) | :heavy_minus_sign: | N/A | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | \ No newline at end of file +| `AdditionalProperties` | map[string][components.ImageGenerationServerToolConfigUnion](../../models/components/imagegenerationservertoolconfigunion) | :heavy_minus_sign: | N/A | \{
"aspect_ratio": "16:9",
"model": "openai/gpt-5-image",
"quality": "high"
} | \ No newline at end of file diff --git a/docs/models/components/imagegenerationservertoolopenrouter.mdx b/docs/models/components/imagegenerationservertoolopenrouter.mdx index d2b38253..a6a52731 100644 --- a/docs/models/components/imagegenerationservertoolopenrouter.mdx +++ b/docs/models/components/imagegenerationservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: generates images from text prompts using an ima | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ImageGenerationServerToolConfig](../../models/components/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` | [components.ImageGenerationServerToolOpenRouterType](../../models/components/imagegenerationservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.ImageGenerationServerToolConfig](../../models/components/imagegenerationservertoolconfig) | :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` | [components.ImageGenerationServerToolOpenRouterType](../../models/components/imagegenerationservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/imagegenerationusage.mdx b/docs/models/components/imagegenerationusage.mdx index a669b07e..dd571e6e 100644 --- a/docs/models/components/imagegenerationusage.mdx +++ b/docs/models/components/imagegenerationusage.mdx @@ -9,16 +9,16 @@ Token and cost usage for the image generation request, when available | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation.mdx)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | +| `CacheCreation` | optionalnullable.OptionalNullable[[components.AnthropicCacheCreation](../../models/components/anthropiccachecreation)] | :heavy_minus_sign: | N/A | \{
"ephemeral_1h_input_tokens": 0,
"ephemeral_5m_input_tokens": 100
} | | `CompletionTokens` | `int64` | :heavy_check_mark: | The tokens generated | | -| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageCompletionTokensDetails](../../models/components/imagegenerationusagecompletiontokensdetails.mdx)] | :heavy_minus_sign: | N/A | | +| `CompletionTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsageCompletionTokensDetails](../../models/components/imagegenerationusagecompletiontokensdetails)] | :heavy_minus_sign: | N/A | | | `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/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
} | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails)] | :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` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration.mdx)] | :heavy_minus_sign: | N/A | | +| `Iterations` | optionalnullable.OptionalNullable[[][components.AnthropicUsageIteration](../../models/components/anthropicusageiteration)] | :heavy_minus_sign: | N/A | | | `PromptTokens` | `int64` | :heavy_check_mark: | Including images, input audio, and tools if any | | -| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsagePromptTokensDetails](../../models/components/imagegenerationusageprompttokensdetails.mdx)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | -| `ServerToolUse` | optionalnullable.OptionalNullable[[components.ServerToolUse](../../models/components/servertooluse.mdx)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | +| `PromptTokensDetails` | optionalnullable.OptionalNullable[[components.ImageGenerationUsagePromptTokensDetails](../../models/components/imagegenerationusageprompttokensdetails)] | :heavy_minus_sign: | Breakdown of tokens used in the prompt. | | +| `ServerToolUse` | optionalnullable.OptionalNullable[[components.ServerToolUse](../../models/components/servertooluse)] | :heavy_minus_sign: | Usage for server-side tool execution (e.g., web search) | | | `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | The service tier used by the upstream provider for this request | | -| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed.mdx)] | :heavy_minus_sign: | N/A | standard | +| `Speed` | optionalnullable.OptionalNullable[[components.AnthropicSpeed](../../models/components/anthropicspeed)] | :heavy_minus_sign: | N/A | standard | | `TotalTokens` | `int64` | :heavy_check_mark: | Sum of the above two fields | | \ No newline at end of file diff --git a/docs/models/components/imagegenpartialimageevent.mdx b/docs/models/components/imagegenpartialimageevent.mdx index 2481d04e..01654644 100644 --- a/docs/models/components/imagegenpartialimageevent.mdx +++ b/docs/models/components/imagegenpartialimageevent.mdx @@ -11,4 +11,4 @@ Emitted when a partial image becomes available during streaming generation | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `B64JSON` | `string` | :heavy_check_mark: | Base64-encoded partial image data | | `PartialImageIndex` | `int64` | :heavy_check_mark: | 0-based index indicating which partial image this is in the sequence | -| `Type` | [components.ImageGenPartialImageEventType](../../models/components/imagegenpartialimageeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file +| `Type` | [components.ImageGenPartialImageEventType](../../models/components/imagegenpartialimageeventtype) | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/models/components/imagegenstreamerrorevent.mdx b/docs/models/components/imagegenstreamerrorevent.mdx index 3d901770..87e0522e 100644 --- a/docs/models/components/imagegenstreamerrorevent.mdx +++ b/docs/models/components/imagegenstreamerrorevent.mdx @@ -9,5 +9,5 @@ Emitted when streaming generation fails after the SSE response starts | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Error` | [components.ImageGenStreamErrorEventError](../../models/components/imagegenstreamerroreventerror.mdx) | :heavy_check_mark: | Provider error details | -| `Type` | [components.ImageGenStreamErrorEventType](../../models/components/imagegenstreamerroreventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file +| `Error` | [components.ImageGenStreamErrorEventError](../../models/components/imagegenstreamerroreventerror) | :heavy_check_mark: | Provider error details | +| `Type` | [components.ImageGenStreamErrorEventType](../../models/components/imagegenstreamerroreventtype) | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/models/components/imagegentextchunkevent.mdx b/docs/models/components/imagegentextchunkevent.mdx index 46d1a6b3..5815c88b 100644 --- a/docs/models/components/imagegentextchunkevent.mdx +++ b/docs/models/components/imagegentextchunkevent.mdx @@ -9,6 +9,6 @@ Emitted when a text chunk becomes available during streaming generation of text- | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `Phase` | [components.ImageGenTextChunkEventPhase](../../models/components/imagegentextchunkeventphase.mdx) | :heavy_check_mark: | The generation phase this chunk belongs to. `content` is the renderable output; `reasoning` and `draft` are intermediate provider phases. | +| `Phase` | [components.ImageGenTextChunkEventPhase](../../models/components/imagegentextchunkeventphase) | :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` | [components.ImageGenTextChunkEventType](../../models/components/imagegentextchunkeventtype.mdx) | :heavy_check_mark: | The event type | \ No newline at end of file +| `Type` | [components.ImageGenTextChunkEventType](../../models/components/imagegentextchunkeventtype) | :heavy_check_mark: | The event type | \ No newline at end of file diff --git a/docs/models/components/imagemodelarchitecture.mdx b/docs/models/components/imagemodelarchitecture.mdx index 467a9ccf..a6796a2a 100644 --- a/docs/models/components/imagemodelarchitecture.mdx +++ b/docs/models/components/imagemodelarchitecture.mdx @@ -6,5 +6,5 @@ title: "ImageModelArchitecture" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `InputModalities` | [][components.ImageInputModality](../../models/components/imageinputmodality.mdx) | :heavy_check_mark: | Supported input modalities | -| `OutputModalities` | [][components.ImageOutputModality](../../models/components/imageoutputmodality.mdx) | :heavy_check_mark: | Supported output modalities | \ No newline at end of file +| `InputModalities` | [][components.ImageInputModality](../../models/components/imageinputmodality) | :heavy_check_mark: | Supported input modalities | +| `OutputModalities` | [][components.ImageOutputModality](../../models/components/imageoutputmodality) | :heavy_check_mark: | Supported output modalities | \ No newline at end of file diff --git a/docs/models/components/imagemodelendpointsresponse.mdx b/docs/models/components/imagemodelendpointsresponse.mdx index 8423e846..f6b03d2f 100644 --- a/docs/models/components/imagemodelendpointsresponse.mdx +++ b/docs/models/components/imagemodelendpointsresponse.mdx @@ -9,5 +9,5 @@ The full per-endpoint records for an image model. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Endpoints` | [][components.ImageEndpoint](../../models/components/imageendpoint.mdx) | :heavy_check_mark: | N/A | | +| `Endpoints` | [][components.ImageEndpoint](../../models/components/imageendpoint) | :heavy_check_mark: | N/A | | | `ID` | `string` | :heavy_check_mark: | Model slug | bytedance-seed/seedream-4.5 | \ No newline at end of file diff --git a/docs/models/components/imagemodellistitem.mdx b/docs/models/components/imagemodellistitem.mdx index 8d66095d..9bc5d43c 100644 --- a/docs/models/components/imagemodellistitem.mdx +++ b/docs/models/components/imagemodellistitem.mdx @@ -9,11 +9,11 @@ A single image model in the discovery listing. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Architecture` | [components.ImageModelArchitecture](../../models/components/imagemodelarchitecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | +| `Architecture` | [components.ImageModelArchitecture](../../models/components/imagemodelarchitecture) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text",
"image"
],
"output_modalities": [
"image"
]
} | | `Created` | `int64` | :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` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor.mdx) | :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"
}
} | +| `SupportedParameters` | map[string][components.CapabilityDescriptor](../../models/components/capabilitydescriptor) | :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` | `bool` | :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 diff --git a/docs/models/components/imagemodelslistresponse.mdx b/docs/models/components/imagemodelslistresponse.mdx index 234ee166..5cd55322 100644 --- a/docs/models/components/imagemodelslistresponse.mdx +++ b/docs/models/components/imagemodelslistresponse.mdx @@ -9,4 +9,4 @@ List of image generation models. | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Data` | [][components.ImageModelListItem](../../models/components/imagemodellistitem.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.ImageModelListItem](../../models/components/imagemodellistitem) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagepricingentry.mdx b/docs/models/components/imagepricingentry.mdx index e31d3ea6..8bc9629f 100644 --- a/docs/models/components/imagepricingentry.mdx +++ b/docs/models/components/imagepricingentry.mdx @@ -9,7 +9,7 @@ One billable pricing line for an image provider. | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Billable` | [components.Billable](../../models/components/billable.mdx) | :heavy_check_mark: | N/A | +| `Billable` | [components.Billable](../../models/components/billable) | :heavy_check_mark: | N/A | | `CostUsd` | `float64` | :heavy_check_mark: | N/A | -| `Unit` | [components.Unit](../../models/components/unit.mdx) | :heavy_check_mark: | N/A | +| `Unit` | [components.Unit](../../models/components/unit) | :heavy_check_mark: | N/A | | `Variant` | `*string` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/imagestreamingresponse.mdx b/docs/models/components/imagestreamingresponse.mdx index d5aa92cc..9e0ecc6e 100644 --- a/docs/models/components/imagestreamingresponse.mdx +++ b/docs/models/components/imagestreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ImageStreamingResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Data` | [components.ImageStreamingResponseData](../../models/components/imagestreamingresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.ImageStreamingResponseData](../../models/components/imagestreamingresponsedata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/incompletedetails.mdx b/docs/models/components/incompletedetails.mdx index 258f4afd..fe993b30 100644 --- a/docs/models/components/incompletedetails.mdx +++ b/docs/models/components/incompletedetails.mdx @@ -6,4 +6,4 @@ title: "IncompleteDetails" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Reason` | [*components.Reason](../../models/components/reason.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Reason` | [*components.Reason](../../models/components/reason) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputaudio.mdx b/docs/models/components/inputaudio.mdx index adb96973..2bea7e1c 100644 --- a/docs/models/components/inputaudio.mdx +++ b/docs/models/components/inputaudio.mdx @@ -9,5 +9,5 @@ Audio input content item | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `InputAudio` | [components.InputAudioInputAudio](../../models/components/inputaudioinputaudio.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.InputAudioType](../../models/components/inputaudiotype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `InputAudio` | [components.InputAudioInputAudio](../../models/components/inputaudioinputaudio) | :heavy_check_mark: | N/A | +| `Type` | [components.InputAudioType](../../models/components/inputaudiotype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputaudioinputaudio.mdx b/docs/models/components/inputaudioinputaudio.mdx index 528acbfb..c9e4586d 100644 --- a/docs/models/components/inputaudioinputaudio.mdx +++ b/docs/models/components/inputaudioinputaudio.mdx @@ -7,4 +7,4 @@ title: "InputAudioInputAudio" | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | `Data` | `string` | :heavy_check_mark: | N/A | -| `Format` | [components.FormatEnum](../../models/components/formatenum.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Format` | [components.FormatEnum](../../models/components/formatenum) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputfile.mdx b/docs/models/components/inputfile.mdx index 68e85f5a..0bd6befb 100644 --- a/docs/models/components/inputfile.mdx +++ b/docs/models/components/inputfile.mdx @@ -13,4 +13,4 @@ File input content item | `FileID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `FileURL` | `*string` | :heavy_minus_sign: | N/A | | `Filename` | `*string` | :heavy_minus_sign: | N/A | -| `Type` | [components.InputFileType](../../models/components/inputfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.InputFileType](../../models/components/inputfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputimage.mdx b/docs/models/components/inputimage.mdx index 326a6c1b..d26730ec 100644 --- a/docs/models/components/inputimage.mdx +++ b/docs/models/components/inputimage.mdx @@ -9,6 +9,6 @@ Image input content item | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Detail` | [components.InputImageDetail](../../models/components/inputimagedetail.mdx) | :heavy_check_mark: | N/A | +| `Detail` | [components.InputImageDetail](../../models/components/inputimagedetail) | :heavy_check_mark: | N/A | | `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.InputImageType](../../models/components/inputimagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.InputImageType](../../models/components/inputimagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputmessageitem.mdx b/docs/models/components/inputmessageitem.mdx index acd9e0a6..5f5180d5 100644 --- a/docs/models/components/inputmessageitem.mdx +++ b/docs/models/components/inputmessageitem.mdx @@ -6,7 +6,7 @@ title: "InputMessageItem" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.InputMessageItemContentUnion](../../models/components/inputmessageitemcontentunion.mdx)] | :heavy_minus_sign: | N/A | +| `Content` | optionalnullable.OptionalNullable[[][components.InputMessageItemContentUnion](../../models/components/inputmessageitemcontentunion)] | :heavy_minus_sign: | N/A | | `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Role` | [components.InputMessageItemRoleUnion](../../models/components/inputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | -| `Type` | [*components.InputMessageItemTypeMessage](../../models/components/inputmessageitemtypemessage.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Role` | [components.InputMessageItemRoleUnion](../../models/components/inputmessageitemroleunion) | :heavy_check_mark: | N/A | +| `Type` | [*components.InputMessageItemTypeMessage](../../models/components/inputmessageitemtypemessage) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputmessageitemcontentinputimage.mdx b/docs/models/components/inputmessageitemcontentinputimage.mdx index 387870e7..a09c46d8 100644 --- a/docs/models/components/inputmessageitemcontentinputimage.mdx +++ b/docs/models/components/inputmessageitemcontentinputimage.mdx @@ -9,6 +9,6 @@ Image input content item | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Detail` | [components.InputMessageItemDetail](../../models/components/inputmessageitemdetail.mdx) | :heavy_check_mark: | N/A | +| `Detail` | [components.InputMessageItemDetail](../../models/components/inputmessageitemdetail) | :heavy_check_mark: | N/A | | `ImageURL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.InputMessageItemTypeInputImage](../../models/components/inputmessageitemtypeinputimage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.InputMessageItemTypeInputImage](../../models/components/inputmessageitemtypeinputimage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputsmessage.mdx b/docs/models/components/inputsmessage.mdx index cb2b10ab..8fa34716 100644 --- a/docs/models/components/inputsmessage.mdx +++ b/docs/models/components/inputsmessage.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [*components.InputsContent2](../../models/components/inputscontent2.mdx) | :heavy_check_mark: | N/A | +| `Content` | [*components.InputsContent2](../../models/components/inputscontent2) | :heavy_check_mark: | N/A | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.InputsPhaseUnion](../../models/components/inputsphaseunion.mdx)] | :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` | [components.InputsRole](../../models/components/inputsrole.mdx) | :heavy_check_mark: | N/A | -| `Status` | [*components.InputsStatusUnion1](../../models/components/inputsstatusunion1.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.InputsTypeMessage](../../models/components/inputstypemessage.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Phase` | optionalnullable.OptionalNullable[[components.InputsPhaseUnion](../../models/components/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` | [components.InputsRole](../../models/components/inputsrole) | :heavy_check_mark: | N/A | +| `Status` | [*components.InputsStatusUnion1](../../models/components/inputsstatusunion1) | :heavy_minus_sign: | N/A | +| `Type` | [components.InputsTypeMessage](../../models/components/inputstypemessage) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/inputsreasoning.mdx b/docs/models/components/inputsreasoning.mdx index d006dc3b..f0c446fc 100644 --- a/docs/models/components/inputsreasoning.mdx +++ b/docs/models/components/inputsreasoning.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent)] | :heavy_minus_sign: | N/A | | | `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [*components.InputsStatusUnion2](../../models/components/inputsstatusunion2.mdx) | :heavy_minus_sign: | N/A | | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.InputsTypeReasoning](../../models/components/inputstypereasoning.mdx) | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Status` | [*components.InputsStatusUnion2](../../models/components/inputsstatusunion2) | :heavy_minus_sign: | N/A | | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext) | :heavy_check_mark: | N/A | | +| `Type` | [components.InputsTypeReasoning](../../models/components/inputstypereasoning) | :heavy_check_mark: | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat)] | :heavy_minus_sign: | N/A | unknown | | `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/components/inputtext.mdx b/docs/models/components/inputtext.mdx index 78cd13dc..4f291633 100644 --- a/docs/models/components/inputtext.mdx +++ b/docs/models/components/inputtext.mdx @@ -9,6 +9,6 @@ Text input content item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/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"
} | +| `PromptCacheBreakpoint` | optionalnullable.OptionalNullable[[components.PromptCacheBreakpoint](../../models/components/promptcachebreakpoint)] | :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` | [components.InputTextType](../../models/components/inputtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.InputTextType](../../models/components/inputtexttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/inputvideo.mdx b/docs/models/components/inputvideo.mdx index 3bd830ba..d49acd40 100644 --- a/docs/models/components/inputvideo.mdx +++ b/docs/models/components/inputvideo.mdx @@ -9,5 +9,5 @@ Video input content item | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Type` | [components.InputVideoType](../../models/components/inputvideotype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.InputVideoType](../../models/components/inputvideotype) | :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 diff --git a/docs/models/components/itemreferenceitem.mdx b/docs/models/components/itemreferenceitem.mdx index 8f066bd2..8e5f91a2 100644 --- a/docs/models/components/itemreferenceitem.mdx +++ b/docs/models/components/itemreferenceitem.mdx @@ -10,4 +10,4 @@ A reference to a previous response item by ID | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ItemReferenceItemType](../../models/components/itemreferenceitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ItemReferenceItemType](../../models/components/itemreferenceitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/keepall.mdx b/docs/models/components/keepall.mdx index ae5186c8..0c09db30 100644 --- a/docs/models/components/keepall.mdx +++ b/docs/models/components/keepall.mdx @@ -6,4 +6,4 @@ title: "KeepAll" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Type` | [components.KeepType](../../models/components/keeptype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.KeepType](../../models/components/keeptype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/legacychatcontentvideo.mdx b/docs/models/components/legacychatcontentvideo.mdx index 424b4663..9dcfb6d1 100644 --- a/docs/models/components/legacychatcontentvideo.mdx +++ b/docs/models/components/legacychatcontentvideo.mdx @@ -11,5 +11,5 @@ Video input content part (legacy format - deprecated) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Type` | [components.LegacyChatContentVideoType](../../models/components/legacychatcontentvideotype.mdx) | :heavy_check_mark: | N/A | | -| `VideoURL` | [components.LegacyChatContentVideoInput](../../models/components/legacychatcontentvideoinput.mdx) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file +| `Type` | [components.LegacyChatContentVideoType](../../models/components/legacychatcontentvideotype) | :heavy_check_mark: | N/A | | +| `VideoURL` | [components.LegacyChatContentVideoInput](../../models/components/legacychatcontentvideoinput) | :heavy_check_mark: | Video input object | \{
"url": "https://example.com/video.mp4"
} | \ No newline at end of file diff --git a/docs/models/components/legacywebsearchservertool.mdx b/docs/models/components/legacywebsearchservertool.mdx index 9b080f0d..00370677 100644 --- a/docs/models/components/legacywebsearchservertool.mdx +++ b/docs/models/components/legacywebsearchservertool.mdx @@ -9,10 +9,10 @@ Web search tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/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` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum) | :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` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | | `MaxResults` | `*int64` | :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` | `*int64` | :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 | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.LegacyWebSearchServerToolType](../../models/components/legacywebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `Type` | [components.LegacyWebSearchServerToolType](../../models/components/legacywebsearchservertooltype) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation)] | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/listbyokkeysresponse.mdx b/docs/models/components/listbyokkeysresponse.mdx index 78aefe26..b3fdcc68 100644 --- a/docs/models/components/listbyokkeysresponse.mdx +++ b/docs/models/components/listbyokkeysresponse.mdx @@ -6,5 +6,5 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Data` | [][components.BYOKKey](../../models/components/byokkey.mdx) | :heavy_check_mark: | List of BYOK credentials. | | +| `Data` | [][components.BYOKKey](../../models/components/byokkey) | :heavy_check_mark: | List of BYOK credentials. | | | `TotalCount` | `int64` | :heavy_check_mark: | Total number of BYOK credentials matching the filters. | 1 | \ No newline at end of file diff --git a/docs/models/components/listendpointsresponse.mdx b/docs/models/components/listendpointsresponse.mdx index 795ee2f8..606be7ba 100644 --- a/docs/models/components/listendpointsresponse.mdx +++ b/docs/models/components/listendpointsresponse.mdx @@ -9,9 +9,9 @@ List of available endpoints for a model | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Architecture` | [components.Architecture](../../models/components/architecture.mdx) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `Architecture` | [components.Architecture](../../models/components/architecture) | :heavy_check_mark: | N/A | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | | `Created` | `int64` | :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` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | :heavy_check_mark: | List of available endpoints for this model | | +| `Endpoints` | [][components.PublicEndpoint](../../models/components/publicendpoint) | :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 diff --git a/docs/models/components/listguardrailsresponse.mdx b/docs/models/components/listguardrailsresponse.mdx index f8330d49..dd0089ff 100644 --- a/docs/models/components/listguardrailsresponse.mdx +++ b/docs/models/components/listguardrailsresponse.mdx @@ -6,5 +6,5 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | List of guardrails | | +| `Data` | [][components.Guardrail](../../models/components/guardrail) | :heavy_check_mark: | List of guardrails | | | `TotalCount` | `int64` | :heavy_check_mark: | Total number of guardrails | 25 | \ No newline at end of file diff --git a/docs/models/components/listkeyassignmentsresponse.mdx b/docs/models/components/listkeyassignmentsresponse.mdx index 50b79025..0d410356 100644 --- a/docs/models/components/listkeyassignmentsresponse.mdx +++ b/docs/models/components/listkeyassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `Data` | [][components.KeyAssignment](../../models/components/keyassignment.mdx) | :heavy_check_mark: | List of key assignments | | +| `Data` | [][components.KeyAssignment](../../models/components/keyassignment) | :heavy_check_mark: | List of key assignments | | | `TotalCount` | `int64` | :heavy_check_mark: | Total number of key assignments for this guardrail | 25 | \ No newline at end of file diff --git a/docs/models/components/listmemberassignmentsresponse.mdx b/docs/models/components/listmemberassignmentsresponse.mdx index 47f80b07..249d782b 100644 --- a/docs/models/components/listmemberassignmentsresponse.mdx +++ b/docs/models/components/listmemberassignmentsresponse.mdx @@ -6,5 +6,5 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Data` | [][components.MemberAssignment](../../models/components/memberassignment.mdx) | :heavy_check_mark: | List of member assignments | | +| `Data` | [][components.MemberAssignment](../../models/components/memberassignment) | :heavy_check_mark: | List of member assignments | | | `TotalCount` | `int64` | :heavy_check_mark: | Total number of member assignments | 10 | \ No newline at end of file diff --git a/docs/models/components/listobservabilitydestinationsresponse.mdx b/docs/models/components/listobservabilitydestinationsresponse.mdx index 0271143f..2b4be83c 100644 --- a/docs/models/components/listobservabilitydestinationsresponse.mdx +++ b/docs/models/components/listobservabilitydestinationsresponse.mdx @@ -6,5 +6,5 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Data` | [][components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | List of observability destinations. | | +| `Data` | [][components.ObservabilityDestination](../../models/components/observabilitydestination) | :heavy_check_mark: | List of observability destinations. | | | `TotalCount` | `int64` | :heavy_check_mark: | Total number of destinations matching the filters. | 1 | \ No newline at end of file diff --git a/docs/models/components/listpresetsresponse.mdx b/docs/models/components/listpresetsresponse.mdx index 1b67ede4..68a52fd6 100644 --- a/docs/models/components/listpresetsresponse.mdx +++ b/docs/models/components/listpresetsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of presets. | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `Data` | [][components.Preset](../../models/components/preset.mdx) | :heavy_check_mark: | N/A | +| `Data` | [][components.Preset](../../models/components/preset) | :heavy_check_mark: | N/A | | `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/listpresetversionsresponse.mdx b/docs/models/components/listpresetversionsresponse.mdx index 625b2bbd..557c084c 100644 --- a/docs/models/components/listpresetversionsresponse.mdx +++ b/docs/models/components/listpresetversionsresponse.mdx @@ -9,5 +9,5 @@ A paginated list of preset versions. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Data` | [][*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion.mdx) | :heavy_check_mark: | N/A | +| `Data` | [][*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion) | :heavy_check_mark: | N/A | | `TotalCount` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/listworkspacebudgetsresponse.mdx b/docs/models/components/listworkspacebudgetsresponse.mdx index 58334bbd..99bf6193 100644 --- a/docs/models/components/listworkspacebudgetsresponse.mdx +++ b/docs/models/components/listworkspacebudgetsresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspaceBudgetsResponse" | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Data` | [][components.WorkspaceBudget](../../models/components/workspacebudget.mdx) | :heavy_check_mark: | List of budgets configured for the workspace | \ No newline at end of file +| `Data` | [][components.WorkspaceBudget](../../models/components/workspacebudget) | :heavy_check_mark: | List of budgets configured for the workspace | \ No newline at end of file diff --git a/docs/models/components/listworkspacemembersresponse.mdx b/docs/models/components/listworkspacemembersresponse.mdx index 101bed62..84515996 100644 --- a/docs/models/components/listworkspacemembersresponse.mdx +++ b/docs/models/components/listworkspacemembersresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember.mdx) | :heavy_check_mark: | List of workspace members | | +| `Data` | [][components.WorkspaceMember](../../models/components/workspacemember) | :heavy_check_mark: | List of workspace members | | | `TotalCount` | `int64` | :heavy_check_mark: | Total number of members in the workspace | 5 | \ No newline at end of file diff --git a/docs/models/components/listworkspacesresponse.mdx b/docs/models/components/listworkspacesresponse.mdx index 8c5ee5bb..3dab9d16 100644 --- a/docs/models/components/listworkspacesresponse.mdx +++ b/docs/models/components/listworkspacesresponse.mdx @@ -6,5 +6,5 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Data` | [][components.Workspace](../../models/components/workspace.mdx) | :heavy_check_mark: | List of workspaces | | +| `Data` | [][components.Workspace](../../models/components/workspace) | :heavy_check_mark: | List of workspaces | | | `TotalCount` | `int64` | :heavy_check_mark: | Total number of workspaces | 5 | \ No newline at end of file diff --git a/docs/models/components/localshellcallitem.mdx b/docs/models/components/localshellcallitem.mdx index 7f239487..71724505 100644 --- a/docs/models/components/localshellcallitem.mdx +++ b/docs/models/components/localshellcallitem.mdx @@ -9,8 +9,8 @@ A local shell command execution call | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `Action` | [components.LocalShellCallItemAction](../../models/components/localshellcallitemaction.mdx) | :heavy_check_mark: | N/A | | +| `Action` | [components.LocalShellCallItemAction](../../models/components/localshellcallitemaction) | :heavy_check_mark: | N/A | | | `CallID` | `string` | :heavy_check_mark: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.TypeLocalShellCall](../../models/components/typelocalshellcall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.TypeLocalShellCall](../../models/components/typelocalshellcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/localshellcallitemaction.mdx b/docs/models/components/localshellcallitemaction.mdx index b78a3a78..e2241d4a 100644 --- a/docs/models/components/localshellcallitemaction.mdx +++ b/docs/models/components/localshellcallitemaction.mdx @@ -9,6 +9,6 @@ title: "LocalShellCallItemAction" | `Command` | []`string` | :heavy_check_mark: | N/A | | `Env` | map[string]`string` | :heavy_check_mark: | N/A | | `TimeoutMs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeExec](../../models/components/typeexec.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.TypeExec](../../models/components/typeexec) | :heavy_check_mark: | N/A | | `User` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `WorkingDirectory` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/localshellcalloutputitem.mdx b/docs/models/components/localshellcalloutputitem.mdx index 14d68167..a8ccb439 100644 --- a/docs/models/components/localshellcalloutputitem.mdx +++ b/docs/models/components/localshellcalloutputitem.mdx @@ -11,5 +11,5 @@ Output from a local shell command execution | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | N/A | | | `Output` | `string` | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.LocalShellCallOutputItemType](../../models/components/localshellcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.LocalShellCallOutputItemType](../../models/components/localshellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/logprob.mdx b/docs/models/components/logprob.mdx index 94c34376..f81c29c8 100644 --- a/docs/models/components/logprob.mdx +++ b/docs/models/components/logprob.mdx @@ -9,4 +9,4 @@ title: "Logprob" | `Bytes` | []`int64` | :heavy_check_mark: | N/A | | `Logprob` | `float64` | :heavy_check_mark: | N/A | | `Token` | `string` | :heavy_check_mark: | N/A | -| `TopLogprobs` | [][components.ResponseOutputTextTopLogprob](../../models/components/responseoutputtexttoplogprob.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `TopLogprobs` | [][components.ResponseOutputTextTopLogprob](../../models/components/responseoutputtexttoplogprob) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpapprovalrequestitem.mdx b/docs/models/components/mcpapprovalrequestitem.mdx index 2bdcd9a2..6889cfc8 100644 --- a/docs/models/components/mcpapprovalrequestitem.mdx +++ b/docs/models/components/mcpapprovalrequestitem.mdx @@ -13,4 +13,4 @@ Request for approval to execute an MCP tool | `ID` | `string` | :heavy_check_mark: | N/A | | `Name` | `string` | :heavy_check_mark: | N/A | | `ServerLabel` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.McpApprovalRequestItemType](../../models/components/mcpapprovalrequestitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.McpApprovalRequestItemType](../../models/components/mcpapprovalrequestitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpapprovalresponseitem.mdx b/docs/models/components/mcpapprovalresponseitem.mdx index a8ff8a03..3fdea6f7 100644 --- a/docs/models/components/mcpapprovalresponseitem.mdx +++ b/docs/models/components/mcpapprovalresponseitem.mdx @@ -13,4 +13,4 @@ User response to an MCP tool approval request | `Approve` | `bool` | :heavy_check_mark: | N/A | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Reason` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.McpApprovalResponseItemType](../../models/components/mcpapprovalresponseitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.McpApprovalResponseItemType](../../models/components/mcpapprovalresponseitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpcallitem.mdx b/docs/models/components/mcpcallitem.mdx index c70f971b..0f435d30 100644 --- a/docs/models/components/mcpcallitem.mdx +++ b/docs/models/components/mcpcallitem.mdx @@ -15,4 +15,4 @@ An MCP tool call with its output or error | `Name` | `string` | :heavy_check_mark: | N/A | | `Output` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `ServerLabel` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.McpCallItemType](../../models/components/mcpcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.McpCallItemType](../../models/components/mcpcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcplisttoolsitem.mdx b/docs/models/components/mcplisttoolsitem.mdx index 3fc1b4f3..324794e4 100644 --- a/docs/models/components/mcplisttoolsitem.mdx +++ b/docs/models/components/mcplisttoolsitem.mdx @@ -12,5 +12,5 @@ List of available MCP tools from a server | `Error` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `ID` | `string` | :heavy_check_mark: | N/A | | `ServerLabel` | `string` | :heavy_check_mark: | N/A | -| `Tools` | [][components.McpListToolsItemTool](../../models/components/mcplisttoolsitemtool.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.McpListToolsItemType](../../models/components/mcplisttoolsitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Tools` | [][components.McpListToolsItemTool](../../models/components/mcplisttoolsitemtool) | :heavy_check_mark: | N/A | +| `Type` | [components.McpListToolsItemType](../../models/components/mcplisttoolsitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/mcpservertool.mdx b/docs/models/components/mcpservertool.mdx index 087a6cc0..f24e3ae8 100644 --- a/docs/models/components/mcpservertool.mdx +++ b/docs/models/components/mcpservertool.mdx @@ -9,12 +9,12 @@ MCP (Model Context Protocol) tool configuration | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `AllowedTools` | optionalnullable.OptionalNullable[[components.AllowedToolsUnion](../../models/components/allowedtoolsunion.mdx)] | :heavy_minus_sign: | N/A | +| `AllowedTools` | optionalnullable.OptionalNullable[[components.AllowedToolsUnion](../../models/components/allowedtoolsunion)] | :heavy_minus_sign: | N/A | | `Authorization` | `*string` | :heavy_minus_sign: | N/A | -| `ConnectorID` | [*components.ConnectorID](../../models/components/connectorid.mdx) | :heavy_minus_sign: | N/A | +| `ConnectorID` | [*components.ConnectorID](../../models/components/connectorid) | :heavy_minus_sign: | N/A | | `Headers` | optionalnullable.OptionalNullable[map[string]`string`] | :heavy_minus_sign: | N/A | -| `RequireApproval` | optionalnullable.OptionalNullable[[components.RequireApprovalUnion](../../models/components/requireapprovalunion.mdx)] | :heavy_minus_sign: | N/A | +| `RequireApproval` | optionalnullable.OptionalNullable[[components.RequireApprovalUnion](../../models/components/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` | [components.McpServerToolType](../../models/components/mcpservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.McpServerToolType](../../models/components/mcpservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesadvisortoolresultblock.mdx b/docs/models/components/messagesadvisortoolresultblock.mdx index bf05787b..dd4f71d5 100644 --- a/docs/models/components/messagesadvisortoolresultblock.mdx +++ b/docs/models/components/messagesadvisortoolresultblock.mdx @@ -11,4 +11,4 @@ Advisor tool result from a prior assistant turn, replayed back to the model on t | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `Content` | map[string]`any` | :heavy_check_mark: | N/A | | `ToolUseID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesAdvisorToolResultBlockType](../../models/components/messagesadvisortoolresultblocktype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.MessagesAdvisorToolResultBlockType](../../models/components/messagesadvisortoolresultblocktype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesmessageparam.mdx b/docs/models/components/messagesmessageparam.mdx index 2aa2bf15..ff9adbf6 100644 --- a/docs/models/components/messagesmessageparam.mdx +++ b/docs/models/components/messagesmessageparam.mdx @@ -9,5 +9,5 @@ Anthropic message with OpenRouter extensions | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Content` | [components.MessagesMessageParamContentUnion5](../../models/components/messagesmessageparamcontentunion5.mdx) | :heavy_check_mark: | N/A | -| `Role` | [components.MessagesMessageParamRole](../../models/components/messagesmessageparamrole.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [components.MessagesMessageParamContentUnion5](../../models/components/messagesmessageparamcontentunion5) | :heavy_check_mark: | N/A | +| `Role` | [components.MessagesMessageParamRole](../../models/components/messagesmessageparamrole) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesoutputconfig.mdx b/docs/models/components/messagesoutputconfig.mdx index 5ec8f99f..9765d107 100644 --- a/docs/models/components/messagesoutputconfig.mdx +++ b/docs/models/components/messagesoutputconfig.mdx @@ -9,6 +9,6 @@ Configuration for controlling output behavior. Supports the effort parameter and | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigEffort](../../models/components/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` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigFormat](../../models/components/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` | optionalnullable.OptionalNullable[[components.TaskBudget](../../models/components/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` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigEffort](../../models/components/messagesoutputconfigeffort)] | :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` | optionalnullable.OptionalNullable[[components.MessagesOutputConfigFormat](../../models/components/messagesoutputconfigformat)] | :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` | optionalnullable.OptionalNullable[[components.TaskBudget](../../models/components/taskbudget)] | :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 diff --git a/docs/models/components/messagesoutputconfigformat.mdx b/docs/models/components/messagesoutputconfigformat.mdx index 5454729a..ca6032c2 100644 --- a/docs/models/components/messagesoutputconfigformat.mdx +++ b/docs/models/components/messagesoutputconfigformat.mdx @@ -10,4 +10,4 @@ A schema to specify Claude's output format in responses. See [structured outputs | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `Schema` | map[string]`any` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesOutputConfigTypeJSONSchema](../../models/components/messagesoutputconfigtypejsonschema.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.MessagesOutputConfigTypeJSONSchema](../../models/components/messagesoutputconfigtypejsonschema) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagesrequest.mdx b/docs/models/components/messagesrequest.mdx index bbcbb2dc..9ea150b2 100644 --- a/docs/models/components/messagesrequest.mdx +++ b/docs/models/components/messagesrequest.mdx @@ -9,29 +9,29 @@ Request schema for Anthropic Messages API endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | optionalnullable.OptionalNullable[[components.ContextManagement](../../models/components/contextmanagement.mdx)] | :heavy_minus_sign: | N/A | | -| `Fallbacks` | optionalnullable.OptionalNullable[[][components.MessagesFallbackParam](../../models/components/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"
}
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | optionalnullable.OptionalNullable[[components.ContextManagement](../../models/components/contextmanagement)] | :heavy_minus_sign: | N/A | | +| `Fallbacks` | optionalnullable.OptionalNullable[[][components.MessagesFallbackParam](../../models/components/messagesfallbackparam)] | :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` | `*int64` | :heavy_minus_sign: | N/A | | -| `Messages` | [][components.MessagesMessageParam](../../models/components/messagesmessageparam.mdx) | :heavy_check_mark: | N/A | | -| `Metadata` | [*components.MessagesRequestMetadata](../../models/components/messagesrequestmetadata.mdx) | :heavy_minus_sign: | N/A | | +| `Messages` | [][components.MessagesMessageParam](../../models/components/messagesmessageparam) | :heavy_check_mark: | N/A | | +| `Metadata` | [*components.MessagesRequestMetadata](../../models/components/messagesrequestmetadata) | :heavy_minus_sign: | N/A | | | `Model` | `string` | :heavy_check_mark: | N/A | | | `Models` | []`string` | :heavy_minus_sign: | N/A | | -| `OutputConfig` | [*components.MessagesOutputConfig](../../models/components/messagesoutputconfig.mdx) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | -| `Plugins` | [][components.MessagesRequestPlugin](../../models/components/messagesrequestplugin.mdx) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | -| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `OutputConfig` | [*components.MessagesOutputConfig](../../models/components/messagesoutputconfig) | :heavy_minus_sign: | Configuration for controlling output behavior. Supports the effort parameter and structured output format. | \{
"effort": "medium"
} | +| `Plugins` | [][components.MessagesRequestPlugin](../../models/components/messagesrequestplugin) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | | `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` | optionalnullable.OptionalNullable[[components.Speed](../../models/components/speed.mdx)] | :heavy_minus_sign: | N/A | fast | +| `Speed` | optionalnullable.OptionalNullable[[components.Speed](../../models/components/speed)] | :heavy_minus_sign: | N/A | fast | | `StopSequences` | []`string` | :heavy_minus_sign: | N/A | | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | :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"
}
] | +| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/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` | `*bool` | :heavy_minus_sign: | N/A | | -| `System` | [*components.System](../../models/components/system.mdx) | :heavy_minus_sign: | N/A | | +| `System` | [*components.System](../../models/components/system) | :heavy_minus_sign: | N/A | | | `Temperature` | `*float64` | :heavy_minus_sign: | N/A | | -| `Thinking` | [*components.Thinking](../../models/components/thinking.mdx) | :heavy_minus_sign: | N/A | | -| `ToolChoice` | [*components.ToolChoice](../../models/components/toolchoice.mdx) | :heavy_minus_sign: | N/A | | -| `Tools` | [][components.MessagesRequestToolUnion](../../models/components/messagesrequesttoolunion.mdx) | :heavy_minus_sign: | N/A | | +| `Thinking` | [*components.Thinking](../../models/components/thinking) | :heavy_minus_sign: | N/A | | +| `ToolChoice` | [*components.ToolChoice](../../models/components/toolchoice) | :heavy_minus_sign: | N/A | | +| `Tools` | [][components.MessagesRequestToolUnion](../../models/components/messagesrequesttoolunion) | :heavy_minus_sign: | N/A | | | `TopK` | `*int64` | :heavy_minus_sign: | N/A | | | `TopP` | `*float64` | :heavy_minus_sign: | N/A | | -| `Trace` | [*components.TraceConfig](../../models/components/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"
} | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig) | :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 diff --git a/docs/models/components/messagessearchmodelsservertool.mdx b/docs/models/components/messagessearchmodelsservertool.mdx index 24e11474..fab9b9cb 100644 --- a/docs/models/components/messagessearchmodelsservertool.mdx +++ b/docs/models/components/messagessearchmodelsservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches and filters AI models available on Ope | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `Type` | [components.MessagesSearchModelsServerToolType](../../models/components/messagessearchmodelsservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `Type` | [components.MessagesSearchModelsServerToolType](../../models/components/messagessearchmodelsservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblock.mdx b/docs/models/components/messagestooladditionblock.mdx index 04bc32b2..e10448f7 100644 --- a/docs/models/components/messagestooladditionblock.mdx +++ b/docs/models/components/messagestooladditionblock.mdx @@ -9,6 +9,6 @@ Loads a previously deferred tool (declared in `tools` with `defer_loading: true` | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [components.MessagesToolAdditionBlockToolUnion](../../models/components/messagestooladditionblocktoolunion.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeToolAddition](../../models/components/typetooladdition.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [components.MessagesToolAdditionBlockToolUnion](../../models/components/messagestooladditionblocktoolunion) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeToolAddition](../../models/components/typetooladdition) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx b/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx index 17210dc9..8940968d 100644 --- a/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx +++ b/docs/models/components/messagestooladditionblocktoolmcptoolreference.mdx @@ -8,4 +8,4 @@ title: "MessagesToolAdditionBlockToolMcpToolReference" | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `Name` | `string` | :heavy_check_mark: | N/A | | `ServerName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../../models/components/messagestooladditionblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolReference](../../models/components/messagestooladditionblocktypemcptoolreference) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx b/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx index f0b3ee7f..72b60f39 100644 --- a/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx +++ b/docs/models/components/messagestooladditionblocktoolmcptoolsetreference.mdx @@ -7,4 +7,4 @@ title: "MessagesToolAdditionBlockToolMcpToolsetReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | | `ServerName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../../models/components/messagestooladditionblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.MessagesToolAdditionBlockTypeMcpToolsetReference](../../models/components/messagestooladditionblocktypemcptoolsetreference) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestooladditionblocktooltoolreference.mdx b/docs/models/components/messagestooladditionblocktooltoolreference.mdx index 2c827a51..cfd2721f 100644 --- a/docs/models/components/messagestooladditionblocktooltoolreference.mdx +++ b/docs/models/components/messagestooladditionblocktooltoolreference.mdx @@ -7,4 +7,4 @@ title: "MessagesToolAdditionBlockToolToolReference" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | | `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolAdditionBlockTypeToolReference](../../models/components/messagestooladditionblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.MessagesToolAdditionBlockTypeToolReference](../../models/components/messagestooladditionblocktypetoolreference) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblock.mdx b/docs/models/components/messagestoolremovalblock.mdx index c1e4f3ff..a166b329 100644 --- a/docs/models/components/messagestoolremovalblock.mdx +++ b/docs/models/components/messagestoolremovalblock.mdx @@ -9,6 +9,6 @@ Removes a tool from the conversation mid-conversation without invalidating the p | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [components.MessagesToolRemovalBlockToolUnion](../../models/components/messagestoolremovalblocktoolunion.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeToolRemoval](../../models/components/typetoolremoval.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [components.MessagesToolRemovalBlockToolUnion](../../models/components/messagestoolremovalblocktoolunion) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeToolRemoval](../../models/components/typetoolremoval) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx b/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx index 5ec3917a..6008ec68 100644 --- a/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx +++ b/docs/models/components/messagestoolremovalblocktoolmcptoolreference.mdx @@ -8,4 +8,4 @@ title: "MessagesToolRemovalBlockToolMcpToolReference" | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `Name` | `string` | :heavy_check_mark: | N/A | | `ServerName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../../models/components/messagestoolremovalblocktypemcptoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolReference](../../models/components/messagestoolremovalblocktypemcptoolreference) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx b/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx index f9f587ae..67530423 100644 --- a/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx +++ b/docs/models/components/messagestoolremovalblocktoolmcptoolsetreference.mdx @@ -7,4 +7,4 @@ title: "MessagesToolRemovalBlockToolMcpToolsetReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `ServerName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../../models/components/messagestoolremovalblocktypemcptoolsetreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.MessagesToolRemovalBlockTypeMcpToolsetReference](../../models/components/messagestoolremovalblocktypemcptoolsetreference) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/messagestoolremovalblocktooltoolreference.mdx b/docs/models/components/messagestoolremovalblocktooltoolreference.mdx index c1448203..1bfa49b3 100644 --- a/docs/models/components/messagestoolremovalblocktooltoolreference.mdx +++ b/docs/models/components/messagestoolremovalblocktooltoolreference.mdx @@ -7,4 +7,4 @@ title: "MessagesToolRemovalBlockToolToolReference" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.MessagesToolRemovalBlockTypeToolReference](../../models/components/messagestoolremovalblocktypetoolreference.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.MessagesToolRemovalBlockTypeToolReference](../../models/components/messagestoolremovalblocktypetoolreference) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/model.mdx b/docs/models/components/model.mdx index f6b30cfe..a034d29e 100644 --- a/docs/models/components/model.mdx +++ b/docs/models/components/model.mdx @@ -9,22 +9,22 @@ Information about an AI model available on OpenRouter | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Architecture` | [components.ModelArchitecture](../../models/components/modelarchitecture.mdx) | :heavy_check_mark: | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | -| `Benchmarks` | [*components.ModelBenchmarks](../../models/components/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
}
]
} | +| `Architecture` | [components.ModelArchitecture](../../models/components/modelarchitecture) | :heavy_check_mark: | Model architecture information | \{
"input_modalities": [
"text"
],
"instruct_type": "chatml",
"modality": "text-\u003etext",
"output_modalities": [
"text"
],
"tokenizer": "GPT"
} | +| `Benchmarks` | [*components.ModelBenchmarks](../../models/components/modelbenchmarks) | :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` | `*int64` | :heavy_check_mark: | Maximum context length in tokens | 8192 | | `Created` | `int64` | :heavy_check_mark: | Unix timestamp of when the model was created | 1692901234 | -| `DefaultParameters` | [*components.DefaultParameters](../../models/components/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
} | +| `DefaultParameters` | [*components.DefaultParameters](../../models/components/defaultparameters) | :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` | optionalnullable.OptionalNullable[`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` | optionalnullable.OptionalNullable[`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` | optionalnullable.OptionalNullable[`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` | [components.ModelLinks](../../models/components/modellinks.mdx) | :heavy_check_mark: | Related API endpoints and resources for this model. | \{
"details": "/api/v1/models/openai/gpt-5.4/endpoints"
} | +| `Links` | [components.ModelLinks](../../models/components/modellinks) | :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` | [*components.PerRequestLimits](../../models/components/perrequestlimits.mdx) | :heavy_check_mark: | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | -| `Pricing` | [components.PublicPricing](../../models/components/publicpricing.mdx) | :heavy_check_mark: | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | -| `Reasoning` | [*components.ModelReasoning](../../models/components/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` | [][components.Parameter](../../models/components/parameter.mdx) | :heavy_check_mark: | List of supported parameters for this model | | +| `PerRequestLimits` | [*components.PerRequestLimits](../../models/components/perrequestlimits) | :heavy_check_mark: | Per-request token limits | \{
"completion_tokens": 1000,
"prompt_tokens": 1000
} | +| `Pricing` | [components.PublicPricing](../../models/components/publicpricing) | :heavy_check_mark: | Pricing information for the model | \{
"completion": "0.00006",
"image": "0",
"prompt": "0.00003",
"request": "0"
} | +| `Reasoning` | [*components.ModelReasoning](../../models/components/modelreasoning) | :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` | [][components.Parameter](../../models/components/parameter) | :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` | [components.TopProviderInfo](../../models/components/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 +| `TopProvider` | [components.TopProviderInfo](../../models/components/topproviderinfo) | :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 diff --git a/docs/models/components/modelarchitecture.mdx b/docs/models/components/modelarchitecture.mdx index 0a41c1fc..6db67a80 100644 --- a/docs/models/components/modelarchitecture.mdx +++ b/docs/models/components/modelarchitecture.mdx @@ -9,8 +9,8 @@ Model architecture information | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `InputModalities` | [][components.InputModality](../../models/components/inputmodality.mdx) | :heavy_check_mark: | Supported input modalities | | -| `InstructType` | optionalnullable.OptionalNullable[[components.InstructType](../../models/components/instructtype.mdx)] | :heavy_minus_sign: | Instruction format type | chatml | +| `InputModalities` | [][components.InputModality](../../models/components/inputmodality) | :heavy_check_mark: | Supported input modalities | | +| `InstructType` | optionalnullable.OptionalNullable[[components.InstructType](../../models/components/instructtype)] | :heavy_minus_sign: | Instruction format type | chatml | | `Modality` | `*string` | :heavy_check_mark: | Primary modality of the model | text->text | -| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality.mdx) | :heavy_check_mark: | Supported output modalities | | -| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup.mdx) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file +| `OutputModalities` | [][components.OutputModality](../../models/components/outputmodality) | :heavy_check_mark: | Supported output modalities | | +| `Tokenizer` | [*components.ModelGroup](../../models/components/modelgroup) | :heavy_minus_sign: | Tokenizer type used by the model | GPT | \ No newline at end of file diff --git a/docs/models/components/modelbenchmarks.mdx b/docs/models/components/modelbenchmarks.mdx index d5cae885..4132add5 100644 --- a/docs/models/components/modelbenchmarks.mdx +++ b/docs/models/components/modelbenchmarks.mdx @@ -9,5 +9,5 @@ Third-party benchmark rankings for this model. Omitted when no benchmark data is | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `ArtificialAnalysis` | [*components.AABenchmarkEntry](../../models/components/aabenchmarkentry.mdx) | :heavy_minus_sign: | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | -| `DesignArena` | [][components.DABenchmarkEntry](../../models/components/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` | [*components.AABenchmarkEntry](../../models/components/aabenchmarkentry) | :heavy_minus_sign: | Artificial Analysis benchmark index scores. | \{
"agentic_index": 55.8,
"coding_index": 63.2,
"intelligence_index": 71.4
} | +| `DesignArena` | [][components.DABenchmarkEntry](../../models/components/dabenchmarkentry) | :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 diff --git a/docs/models/components/modelreasoning.mdx b/docs/models/components/modelreasoning.mdx index 4888367c..23ec442a 100644 --- a/docs/models/components/modelreasoning.mdx +++ b/docs/models/components/modelreasoning.mdx @@ -9,8 +9,8 @@ Reasoning effort configuration. Omitted for non-reasoning models and dynamic rou | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `DefaultEffort` | optionalnullable.OptionalNullable[[components.DefaultEffort](../../models/components/defaulteffort.mdx)] | :heavy_minus_sign: | N/A | medium | +| `DefaultEffort` | optionalnullable.OptionalNullable[[components.DefaultEffort](../../models/components/defaulteffort)] | :heavy_minus_sign: | N/A | medium | | `DefaultEnabled` | `*bool` | :heavy_minus_sign: | Default reasoning enabled state when the client does not set `reasoning.enabled`. | | | `Mandatory` | `bool` | :heavy_check_mark: | When true, reasoning cannot be disabled and effort "none" is rejected. | | -| `SupportedEfforts` | optionalnullable.OptionalNullable[[][*components.ReasoningEffort](../../models/components/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. | | +| `SupportedEfforts` | optionalnullable.OptionalNullable[[][*components.ReasoningEffort](../../models/components/reasoningeffort)] | :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` | `*bool` | :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 diff --git a/docs/models/components/modelresponse.mdx b/docs/models/components/modelresponse.mdx index ac70fdd9..04052cc8 100644 --- a/docs/models/components/modelresponse.mdx +++ b/docs/models/components/modelresponse.mdx @@ -9,4 +9,4 @@ Single model response | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Model](../../models/components/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` | [components.Model](../../models/components/model) | :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 diff --git a/docs/models/components/modelscountresponse.mdx b/docs/models/components/modelscountresponse.mdx index 04b817d9..f3159e59 100644 --- a/docs/models/components/modelscountresponse.mdx +++ b/docs/models/components/modelscountresponse.mdx @@ -9,4 +9,4 @@ Model count data | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Data` | [components.ModelsCountResponseData](../../models/components/modelscountresponsedata.mdx) | :heavy_check_mark: | Model count data | \{
"count": 150
} | \ No newline at end of file +| `Data` | [components.ModelsCountResponseData](../../models/components/modelscountresponsedata) | :heavy_check_mark: | Model count data | \{
"count": 150
} | \ No newline at end of file diff --git a/docs/models/components/modelslistresponse.mdx b/docs/models/components/modelslistresponse.mdx index 65083cba..e5c0a331 100644 --- a/docs/models/components/modelslistresponse.mdx +++ b/docs/models/components/modelslistresponse.mdx @@ -9,6 +9,6 @@ List of available models | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.Model](../../models/components/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` | [components.Links](../../models/components/links.mdx) | :heavy_check_mark: | Pagination links | | +| `Data` | [][components.Model](../../models/components/model) | :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` | [components.Links](../../models/components/links) | :heavy_check_mark: | Pagination links | | | `TotalCount` | `int64` | :heavy_check_mark: | Total number of models matching the query | 150 | \ No newline at end of file diff --git a/docs/models/components/moderationplugin.mdx b/docs/models/components/moderationplugin.mdx index 589e0cdd..1b89695a 100644 --- a/docs/models/components/moderationplugin.mdx +++ b/docs/models/components/moderationplugin.mdx @@ -6,4 +6,4 @@ title: "ModerationPlugin" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `ID` | [components.ModerationPluginID](../../models/components/moderationpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ID` | [components.ModerationPluginID](../../models/components/moderationpluginid) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/namespacefunctiontool.mdx b/docs/models/components/namespacefunctiontool.mdx index b667b997..78aa6e89 100644 --- a/docs/models/components/namespacefunctiontool.mdx +++ b/docs/models/components/namespacefunctiontool.mdx @@ -9,11 +9,11 @@ A function tool grouped inside a namespace tool | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `AllowedCallers` | optionalnullable.OptionalNullable[[][components.AllowedCaller](../../models/components/allowedcaller.mdx)] | :heavy_minus_sign: | N/A | +| `AllowedCallers` | optionalnullable.OptionalNullable[[][components.AllowedCaller](../../models/components/allowedcaller)] | :heavy_minus_sign: | N/A | | `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Name` | `string` | :heavy_check_mark: | N/A | | `OutputSchema` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | | `Parameters` | optionalnullable.OptionalNullable[map[string]`any`] | :heavy_minus_sign: | N/A | | `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | -| `Type` | [components.NamespaceFunctionToolType](../../models/components/namespacefunctiontooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.NamespaceFunctionToolType](../../models/components/namespacefunctiontooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/namespacetool.mdx b/docs/models/components/namespacetool.mdx index 63b20c09..9ef28f34 100644 --- a/docs/models/components/namespacetool.mdx +++ b/docs/models/components/namespacetool.mdx @@ -11,5 +11,5 @@ Groups function/custom tools under a shared namespace | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `Description` | `string` | :heavy_check_mark: | N/A | | `Name` | `string` | :heavy_check_mark: | N/A | -| `Tools` | [][components.NamespaceToolTool](../../models/components/namespacetooltool.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.NamespaceToolType](../../models/components/namespacetooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Tools` | [][components.NamespaceToolTool](../../models/components/namespacetooltool) | :heavy_check_mark: | N/A | +| `Type` | [components.NamespaceToolType](../../models/components/namespacetooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityarizedestination.mdx b/docs/models/components/observabilityarizedestination.mdx index 93aaa679..70cfd74d 100644 --- a/docs/models/components/observabilityarizedestination.mdx +++ b/docs/models/components/observabilityarizedestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityArizeDestinationConfig](../../models/components/observabilityarizedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityArizeDestinationConfig](../../models/components/observabilityarizedestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityArizeDestinationType](../../models/components/observabilityarizedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityArizeDestinationType](../../models/components/observabilityarizedestinationtype) | :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 diff --git a/docs/models/components/observabilitybraintrustdestination.mdx b/docs/models/components/observabilitybraintrustdestination.mdx index ab6d5ed3..4854a37d 100644 --- a/docs/models/components/observabilitybraintrustdestination.mdx +++ b/docs/models/components/observabilitybraintrustdestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityBraintrustDestinationConfig](../../models/components/observabilitybraintrustdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityBraintrustDestinationConfig](../../models/components/observabilitybraintrustdestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityBraintrustDestinationType](../../models/components/observabilitybraintrustdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityBraintrustDestinationType](../../models/components/observabilitybraintrustdestinationtype) | :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 diff --git a/docs/models/components/observabilityclickhousedestination.mdx b/docs/models/components/observabilityclickhousedestination.mdx index 16f668c9..8aefab29 100644 --- a/docs/models/components/observabilityclickhousedestination.mdx +++ b/docs/models/components/observabilityclickhousedestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityClickhouseDestinationConfig](../../models/components/observabilityclickhousedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityClickhouseDestinationConfig](../../models/components/observabilityclickhousedestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityClickhouseDestinationType](../../models/components/observabilityclickhousedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityClickhouseDestinationType](../../models/components/observabilityclickhousedestinationtype) | :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 diff --git a/docs/models/components/observabilitydatadogdestination.mdx b/docs/models/components/observabilitydatadogdestination.mdx index 2d5e6c16..89a46a9e 100644 --- a/docs/models/components/observabilitydatadogdestination.mdx +++ b/docs/models/components/observabilitydatadogdestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityDatadogDestinationConfig](../../models/components/observabilitydatadogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityDatadogDestinationConfig](../../models/components/observabilitydatadogdestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityDatadogDestinationType](../../models/components/observabilitydatadogdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityDatadogDestinationType](../../models/components/observabilitydatadogdestinationtype) | :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 diff --git a/docs/models/components/observabilityfilterrulegroup.mdx b/docs/models/components/observabilityfilterrulegroup.mdx index a9a09169..d84dff8e 100644 --- a/docs/models/components/observabilityfilterrulegroup.mdx +++ b/docs/models/components/observabilityfilterrulegroup.mdx @@ -6,5 +6,5 @@ title: "ObservabilityFilterRuleGroup" | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `Logic` | [*components.Logic](../../models/components/logic.mdx) | :heavy_minus_sign: | N/A | -| `Rules` | [][components.Rule](../../models/components/rule.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Logic` | [*components.Logic](../../models/components/logic) | :heavy_minus_sign: | N/A | +| `Rules` | [][components.Rule](../../models/components/rule) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityfilterrulesconfig.mdx b/docs/models/components/observabilityfilterrulesconfig.mdx index a7593a36..e4805f74 100644 --- a/docs/models/components/observabilityfilterrulesconfig.mdx +++ b/docs/models/components/observabilityfilterrulesconfig.mdx @@ -10,4 +10,4 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `Enabled` | `*bool` | :heavy_minus_sign: | N/A | -| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityfilterrulesconfignullable.mdx b/docs/models/components/observabilityfilterrulesconfignullable.mdx index adfe7915..1bc62c37 100644 --- a/docs/models/components/observabilityfilterrulesconfignullable.mdx +++ b/docs/models/components/observabilityfilterrulesconfignullable.mdx @@ -10,4 +10,4 @@ Optional structured filter rules controlling which events are forwarded. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `Enabled` | `*bool` | :heavy_minus_sign: | N/A | -| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Groups` | [][components.ObservabilityFilterRuleGroup](../../models/components/observabilityfilterrulegroup) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilitygrafanadestination.mdx b/docs/models/components/observabilitygrafanadestination.mdx index 04f2e425..8deee483 100644 --- a/docs/models/components/observabilitygrafanadestination.mdx +++ b/docs/models/components/observabilitygrafanadestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityGrafanaDestinationConfig](../../models/components/observabilitygrafanadestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityGrafanaDestinationConfig](../../models/components/observabilitygrafanadestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityGrafanaDestinationType](../../models/components/observabilitygrafanadestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityGrafanaDestinationType](../../models/components/observabilitygrafanadestinationtype) | :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 diff --git a/docs/models/components/observabilitylangfusedestination.mdx b/docs/models/components/observabilitylangfusedestination.mdx index 2efb405b..de971c92 100644 --- a/docs/models/components/observabilitylangfusedestination.mdx +++ b/docs/models/components/observabilitylangfusedestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityLangfuseDestinationConfig](../../models/components/observabilitylangfusedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityLangfuseDestinationConfig](../../models/components/observabilitylangfusedestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityLangfuseDestinationType](../../models/components/observabilitylangfusedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityLangfuseDestinationType](../../models/components/observabilitylangfusedestinationtype) | :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 diff --git a/docs/models/components/observabilitylangsmithdestination.mdx b/docs/models/components/observabilitylangsmithdestination.mdx index fadf8be2..8c7d25b8 100644 --- a/docs/models/components/observabilitylangsmithdestination.mdx +++ b/docs/models/components/observabilitylangsmithdestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityLangsmithDestinationConfig](../../models/components/observabilitylangsmithdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityLangsmithDestinationConfig](../../models/components/observabilitylangsmithdestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityLangsmithDestinationType](../../models/components/observabilitylangsmithdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityLangsmithDestinationType](../../models/components/observabilitylangsmithdestinationtype) | :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 diff --git a/docs/models/components/observabilitynewrelicdestination.mdx b/docs/models/components/observabilitynewrelicdestination.mdx index 9c27fdee..47c05597 100644 --- a/docs/models/components/observabilitynewrelicdestination.mdx +++ b/docs/models/components/observabilitynewrelicdestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityNewrelicDestinationConfig](../../models/components/observabilitynewrelicdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityNewrelicDestinationConfig](../../models/components/observabilitynewrelicdestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityNewrelicDestinationType](../../models/components/observabilitynewrelicdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityNewrelicDestinationType](../../models/components/observabilitynewrelicdestinationtype) | :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 diff --git a/docs/models/components/observabilitynewrelicdestinationconfig.mdx b/docs/models/components/observabilitynewrelicdestinationconfig.mdx index 380655d7..85a5091b 100644 --- a/docs/models/components/observabilitynewrelicdestinationconfig.mdx +++ b/docs/models/components/observabilitynewrelicdestinationconfig.mdx @@ -8,4 +8,4 @@ title: "ObservabilityNewrelicDestinationConfig" | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | | `Headers` | map[string]`string` | :heavy_minus_sign: | Custom HTTP headers to include in requests to this destination. | | `LicenseKey` | `string` | :heavy_check_mark: | N/A | -| `Region` | [*components.Region](../../models/components/region.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Region` | [*components.Region](../../models/components/region) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/observabilityopikdestination.mdx b/docs/models/components/observabilityopikdestination.mdx index ea375a90..5e06f88a 100644 --- a/docs/models/components/observabilityopikdestination.mdx +++ b/docs/models/components/observabilityopikdestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityOpikDestinationConfig](../../models/components/observabilityopikdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityOpikDestinationConfig](../../models/components/observabilityopikdestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityOpikDestinationType](../../models/components/observabilityopikdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityOpikDestinationType](../../models/components/observabilityopikdestinationtype) | :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 diff --git a/docs/models/components/observabilityotelcollectordestination.mdx b/docs/models/components/observabilityotelcollectordestination.mdx index 997c9efd..6cb98c02 100644 --- a/docs/models/components/observabilityotelcollectordestination.mdx +++ b/docs/models/components/observabilityotelcollectordestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityOtelCollectorDestinationConfig](../../models/components/observabilityotelcollectordestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityOtelCollectorDestinationConfig](../../models/components/observabilityotelcollectordestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityOtelCollectorDestinationType](../../models/components/observabilityotelcollectordestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityOtelCollectorDestinationType](../../models/components/observabilityotelcollectordestinationtype) | :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 diff --git a/docs/models/components/observabilityposthogdestination.mdx b/docs/models/components/observabilityposthogdestination.mdx index 59c5d35c..f924e782 100644 --- a/docs/models/components/observabilityposthogdestination.mdx +++ b/docs/models/components/observabilityposthogdestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityPosthogDestinationConfig](../../models/components/observabilityposthogdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityPosthogDestinationConfig](../../models/components/observabilityposthogdestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityPosthogDestinationType](../../models/components/observabilityposthogdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityPosthogDestinationType](../../models/components/observabilityposthogdestinationtype) | :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 diff --git a/docs/models/components/observabilityrampdestination.mdx b/docs/models/components/observabilityrampdestination.mdx index 04b26f32..9e4e8c89 100644 --- a/docs/models/components/observabilityrampdestination.mdx +++ b/docs/models/components/observabilityrampdestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityRampDestinationConfig](../../models/components/observabilityrampdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityRampDestinationConfig](../../models/components/observabilityrampdestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityRampDestinationType](../../models/components/observabilityrampdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityRampDestinationType](../../models/components/observabilityrampdestinationtype) | :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 diff --git a/docs/models/components/observabilitys3destination.mdx b/docs/models/components/observabilitys3destination.mdx index 1e8d7b95..f97d38bb 100644 --- a/docs/models/components/observabilitys3destination.mdx +++ b/docs/models/components/observabilitys3destination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityS3DestinationConfig](../../models/components/observabilitys3destinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityS3DestinationConfig](../../models/components/observabilitys3destinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityS3DestinationType](../../models/components/observabilitys3destinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityS3DestinationType](../../models/components/observabilitys3destinationtype) | :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 diff --git a/docs/models/components/observabilitysentrydestination.mdx b/docs/models/components/observabilitysentrydestination.mdx index c668bef6..247c0b57 100644 --- a/docs/models/components/observabilitysentrydestination.mdx +++ b/docs/models/components/observabilitysentrydestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilitySentryDestinationConfig](../../models/components/observabilitysentrydestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilitySentryDestinationConfig](../../models/components/observabilitysentrydestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilitySentryDestinationType](../../models/components/observabilitysentrydestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilitySentryDestinationType](../../models/components/observabilitysentrydestinationtype) | :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 diff --git a/docs/models/components/observabilitysnowflakedestination.mdx b/docs/models/components/observabilitysnowflakedestination.mdx index 923cf70d..2757e383 100644 --- a/docs/models/components/observabilitysnowflakedestination.mdx +++ b/docs/models/components/observabilitysnowflakedestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilitySnowflakeDestinationConfig](../../models/components/observabilitysnowflakedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilitySnowflakeDestinationConfig](../../models/components/observabilitysnowflakedestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilitySnowflakeDestinationType](../../models/components/observabilitysnowflakedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilitySnowflakeDestinationType](../../models/components/observabilitysnowflakedestinationtype) | :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 diff --git a/docs/models/components/observabilityweavedestination.mdx b/docs/models/components/observabilityweavedestination.mdx index 9424b645..6d47eef8 100644 --- a/docs/models/components/observabilityweavedestination.mdx +++ b/docs/models/components/observabilityweavedestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityWeaveDestinationConfig](../../models/components/observabilityweavedestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityWeaveDestinationConfig](../../models/components/observabilityweavedestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityWeaveDestinationType](../../models/components/observabilityweavedestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityWeaveDestinationType](../../models/components/observabilityweavedestinationtype) | :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 diff --git a/docs/models/components/observabilitywebhookdestination.mdx b/docs/models/components/observabilitywebhookdestination.mdx index 6dfb8642..f1d96b01 100644 --- a/docs/models/components/observabilitywebhookdestination.mdx +++ b/docs/models/components/observabilitywebhookdestination.mdx @@ -7,14 +7,14 @@ title: "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 | -| `Config` | [components.ObservabilityWebhookDestinationConfig](../../models/components/observabilitywebhookdestinationconfig.mdx) | :heavy_check_mark: | N/A | | +| `Config` | [components.ObservabilityWebhookDestinationConfig](../../models/components/observabilitywebhookdestinationconfig) | :heavy_check_mark: | N/A | | | `CreatedAt` | `string` | :heavy_check_mark: | ISO timestamp of when the destination was created. | 2025-08-24T10:30:00Z | | `Enabled` | `bool` | :heavy_check_mark: | Whether this destination is currently enabled. | true | -| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig.mdx) | :heavy_check_mark: | Optional structured filter rules controlling which events are forwarded. | null | +| `FilterRules` | [*components.ObservabilityFilterRulesConfig](../../models/components/observabilityfilterrulesconfig) | :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` | `bool` | :heavy_check_mark: | When true, request/response bodies are not forwarded to this destination — only metadata. | false | | `SamplingRate` | `float64` | :heavy_check_mark: | Sampling rate for events sent to this destination, between 0.0001 and 1 (1 = 100%). | 1 | -| `Type` | [components.ObservabilityWebhookDestinationType](../../models/components/observabilitywebhookdestinationtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.ObservabilityWebhookDestinationType](../../models/components/observabilitywebhookdestinationtype) | :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 diff --git a/docs/models/components/observabilitywebhookdestinationconfig.mdx b/docs/models/components/observabilitywebhookdestinationconfig.mdx index 330f8522..c481e21e 100644 --- a/docs/models/components/observabilitywebhookdestinationconfig.mdx +++ b/docs/models/components/observabilitywebhookdestinationconfig.mdx @@ -7,5 +7,5 @@ title: "ObservabilityWebhookDestinationConfig" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | `Headers` | map[string]`string` | :heavy_minus_sign: | N/A | -| `Method` | [*components.Method](../../models/components/method.mdx) | :heavy_minus_sign: | N/A | +| `Method` | [*components.Method](../../models/components/method) | :heavy_minus_sign: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openaifile.mdx b/docs/models/components/openaifile.mdx index ce6c7c6f..cfb38af9 100644 --- a/docs/models/components/openaifile.mdx +++ b/docs/models/components/openaifile.mdx @@ -9,11 +9,11 @@ A stored file in OpenAI's Files API shape. | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `Shape` | [components.OpenAIFileShape](../../models/components/openaifileshape.mdx) | :heavy_check_mark: | N/A | +| `Shape` | [components.OpenAIFileShape](../../models/components/openaifileshape) | :heavy_check_mark: | N/A | | `Bytes` | `int64` | :heavy_check_mark: | N/A | | `CreatedAt` | `int64` | :heavy_check_mark: | N/A | | `Filename` | `string` | :heavy_check_mark: | N/A | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Object` | [components.OpenAIFileObject](../../models/components/openaifileobject.mdx) | :heavy_check_mark: | N/A | -| `Purpose` | [components.Purpose](../../models/components/purpose.mdx) | :heavy_check_mark: | N/A | -| `Status` | [components.OpenAIFileStatus](../../models/components/openaifilestatus.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Object` | [components.OpenAIFileObject](../../models/components/openaifileobject) | :heavy_check_mark: | N/A | +| `Purpose` | [components.Purpose](../../models/components/purpose) | :heavy_check_mark: | N/A | +| `Status` | [components.OpenAIFileStatus](../../models/components/openaifilestatus) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openaifiledeleted.mdx b/docs/models/components/openaifiledeleted.mdx index 5e9e8bb9..62d75f14 100644 --- a/docs/models/components/openaifiledeleted.mdx +++ b/docs/models/components/openaifiledeleted.mdx @@ -9,7 +9,7 @@ Deletion result in OpenAI's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Shape` | [components.OpenAIFileDeletedShape](../../models/components/openaifiledeletedshape.mdx) | :heavy_check_mark: | N/A | +| `Shape` | [components.OpenAIFileDeletedShape](../../models/components/openaifiledeletedshape) | :heavy_check_mark: | N/A | | `Deleted` | `bool` | :heavy_check_mark: | N/A | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Object` | [components.OpenAIFileDeletedObject](../../models/components/openaifiledeletedobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Object` | [components.OpenAIFileDeletedObject](../../models/components/openaifiledeletedobject) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openaifilelist.mdx b/docs/models/components/openaifilelist.mdx index 4222fe91..546a2e9c 100644 --- a/docs/models/components/openaifilelist.mdx +++ b/docs/models/components/openaifilelist.mdx @@ -9,9 +9,9 @@ A page of files in OpenAI's shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `Shape` | [components.OpenAIFileListShape](../../models/components/openaifilelistshape.mdx) | :heavy_check_mark: | N/A | -| `Data` | [][components.OpenAIFile](../../models/components/openaifile.mdx) | :heavy_check_mark: | N/A | +| `Shape` | [components.OpenAIFileListShape](../../models/components/openaifilelistshape) | :heavy_check_mark: | N/A | +| `Data` | [][components.OpenAIFile](../../models/components/openaifile) | :heavy_check_mark: | N/A | | `FirstID` | `*string` | :heavy_check_mark: | N/A | | `HasMore` | `bool` | :heavy_check_mark: | N/A | | `LastID` | `*string` | :heavy_check_mark: | N/A | -| `Object` | [components.OpenAIFileListObject](../../models/components/openaifilelistobject.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Object` | [components.OpenAIFileListObject](../../models/components/openaifilelistobject) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsecustomtoolcall.mdx b/docs/models/components/openairesponsecustomtoolcall.mdx index cd72d3a9..1fdb72e7 100644 --- a/docs/models/components/openairesponsecustomtoolcall.mdx +++ b/docs/models/components/openairesponsecustomtoolcall.mdx @@ -11,4 +11,4 @@ title: "OpenAIResponseCustomToolCall" | `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` | [components.OpenAIResponseCustomToolCallType](../../models/components/openairesponsecustomtoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenAIResponseCustomToolCallType](../../models/components/openairesponsecustomtoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsecustomtoolcalloutput.mdx b/docs/models/components/openairesponsecustomtoolcalloutput.mdx index 726441b3..cf8ffa24 100644 --- a/docs/models/components/openairesponsecustomtoolcalloutput.mdx +++ b/docs/models/components/openairesponsecustomtoolcalloutput.mdx @@ -8,5 +8,5 @@ title: "OpenAIResponseCustomToolCallOutput" | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `CallID` | `string` | :heavy_check_mark: | N/A | | `ID` | `*string` | :heavy_minus_sign: | N/A | -| `Output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../../models/components/openairesponsecustomtoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.OpenAIResponseCustomToolCallOutputType](../../models/components/openairesponsecustomtoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Output` | [components.OpenAIResponseCustomToolCallOutputOutput2](../../models/components/openairesponsecustomtoolcalloutputoutput2) | :heavy_check_mark: | N/A | +| `Type` | [components.OpenAIResponseCustomToolCallOutputType](../../models/components/openairesponsecustomtoolcalloutputtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsefunctiontoolcall.mdx b/docs/models/components/openairesponsefunctiontoolcall.mdx index be7a8808..92e181f1 100644 --- a/docs/models/components/openairesponsefunctiontoolcall.mdx +++ b/docs/models/components/openairesponsefunctiontoolcall.mdx @@ -11,5 +11,5 @@ title: "OpenAIResponseFunctionToolCall" | `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` | [*components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.OpenAIResponseFunctionToolCallType](../../models/components/openairesponsefunctiontoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [*components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.OpenAIResponseFunctionToolCallType](../../models/components/openairesponsefunctiontoolcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openairesponsefunctiontoolcalloutput.mdx b/docs/models/components/openairesponsefunctiontoolcalloutput.mdx index e464d154..bee63b6a 100644 --- a/docs/models/components/openairesponsefunctiontoolcalloutput.mdx +++ b/docs/models/components/openairesponsefunctiontoolcalloutput.mdx @@ -8,6 +8,6 @@ title: "OpenAIResponseFunctionToolCallOutput" | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `CallID` | `string` | :heavy_check_mark: | N/A | | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../../models/components/openairesponsefunctiontoolcalloutputoutput2.mdx) | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.OpenAIResponseFunctionToolCallOutputType](../../models/components/openairesponsefunctiontoolcalloutputtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Output` | [components.OpenAIResponseFunctionToolCallOutputOutput2](../../models/components/openairesponsefunctiontoolcalloutputoutput2) | :heavy_check_mark: | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.OpenAIResponseFunctionToolCallOutputType](../../models/components/openairesponsefunctiontoolcalloutputtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openairesponseinputmessageitem.mdx b/docs/models/components/openairesponseinputmessageitem.mdx index 8d8a2353..dc20b7d0 100644 --- a/docs/models/components/openairesponseinputmessageitem.mdx +++ b/docs/models/components/openairesponseinputmessageitem.mdx @@ -6,7 +6,7 @@ title: "OpenAIResponseInputMessageItem" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Content` | [][components.OpenAIResponseInputMessageItemContent](../../models/components/openairesponseinputmessageitemcontent.mdx) | :heavy_check_mark: | N/A | +| `Content` | [][components.OpenAIResponseInputMessageItemContent](../../models/components/openairesponseinputmessageitemcontent) | :heavy_check_mark: | N/A | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Role` | [components.OpenAIResponseInputMessageItemRoleUnion](../../models/components/openairesponseinputmessageitemroleunion.mdx) | :heavy_check_mark: | N/A | -| `Type` | [*components.OpenAIResponseInputMessageItemType](../../models/components/openairesponseinputmessageitemtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Role` | [components.OpenAIResponseInputMessageItemRoleUnion](../../models/components/openairesponseinputmessageitemroleunion) | :heavy_check_mark: | N/A | +| `Type` | [*components.OpenAIResponseInputMessageItemType](../../models/components/openairesponseinputmessageitemtype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsesrefusalcontent.mdx b/docs/models/components/openairesponsesrefusalcontent.mdx index e412ff66..63aecf84 100644 --- a/docs/models/components/openairesponsesrefusalcontent.mdx +++ b/docs/models/components/openairesponsesrefusalcontent.mdx @@ -7,4 +7,4 @@ title: "OpenAIResponsesRefusalContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `Refusal` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenAIResponsesRefusalContentType](../../models/components/openairesponsesrefusalcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenAIResponsesRefusalContentType](../../models/components/openairesponsesrefusalcontenttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoice.mdx b/docs/models/components/openairesponsestoolchoice.mdx index cfeeb25d..6fd3f614 100644 --- a/docs/models/components/openairesponsestoolchoice.mdx +++ b/docs/models/components/openairesponsestoolchoice.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoice" | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Type` | [components.Type](../../models/components/type.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.Type](../../models/components/type) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoiceapplypatch.mdx b/docs/models/components/openairesponsestoolchoiceapplypatch.mdx index d37e00a5..15cdd63e 100644 --- a/docs/models/components/openairesponsestoolchoiceapplypatch.mdx +++ b/docs/models/components/openairesponsestoolchoiceapplypatch.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceApplyPatch" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../../models/components/openairesponsestoolchoicetypeapplypatch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenAIResponsesToolChoiceTypeApplyPatch](../../models/components/openairesponsestoolchoicetypeapplypatch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoicefunction.mdx b/docs/models/components/openairesponsestoolchoicefunction.mdx index f9607fb9..e8247e74 100644 --- a/docs/models/components/openairesponsestoolchoicefunction.mdx +++ b/docs/models/components/openairesponsestoolchoicefunction.mdx @@ -7,4 +7,4 @@ title: "OpenAIResponsesToolChoiceFunction" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenAIResponsesToolChoiceTypeFunction](../../models/components/openairesponsestoolchoicetypefunction.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenAIResponsesToolChoiceTypeFunction](../../models/components/openairesponsestoolchoicetypefunction) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openairesponsestoolchoiceshell.mdx b/docs/models/components/openairesponsestoolchoiceshell.mdx index f964fb9c..d4269c90 100644 --- a/docs/models/components/openairesponsestoolchoiceshell.mdx +++ b/docs/models/components/openairesponsestoolchoiceshell.mdx @@ -6,4 +6,4 @@ title: "OpenAIResponsesToolChoiceShell" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OpenAIResponsesToolChoiceTypeShell](../../models/components/openairesponsestoolchoicetypeshell.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenAIResponsesToolChoiceTypeShell](../../models/components/openairesponsestoolchoicetypeshell) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openresponsescreatedevent.mdx b/docs/models/components/openresponsescreatedevent.mdx index 50c25248..bfaf3632 100644 --- a/docs/models/components/openresponsescreatedevent.mdx +++ b/docs/models/components/openresponsescreatedevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is created | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/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
}
} | +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult) | :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` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.OpenResponsesCreatedEventType](../../models/components/openresponsescreatedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.OpenResponsesCreatedEventType](../../models/components/openresponsescreatedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openresponsesinprogressevent.mdx b/docs/models/components/openresponsesinprogressevent.mdx index e08c1e18..53453727 100644 --- a/docs/models/components/openresponsesinprogressevent.mdx +++ b/docs/models/components/openresponsesinprogressevent.mdx @@ -9,6 +9,6 @@ Event emitted when a response is in progress | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/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
}
} | +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult) | :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` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.OpenResponsesInProgressEventType](../../models/components/openresponsesinprogresseventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.OpenResponsesInProgressEventType](../../models/components/openresponsesinprogresseventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openresponsesresult.mdx b/docs/models/components/openresponsesresult.mdx index 9f4e8e99..d5341577 100644 --- a/docs/models/components/openresponsesresult.mdx +++ b/docs/models/components/openresponsesresult.mdx @@ -12,37 +12,37 @@ Complete non-streaming response from the Responses API | `Background` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | | `CompletedAt` | `*int64` | :heavy_check_mark: | N/A | | | `CreatedAt` | `int64` | :heavy_check_mark: | N/A | | -| `Error` | [*components.ResponsesErrorField](../../models/components/responseserrorfield.mdx) | :heavy_check_mark: | Error information returned from the API | \{
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded. Please try again later."
} | +| `Error` | [*components.ResponsesErrorField](../../models/components/responseserrorfield) | :heavy_check_mark: | Error information returned from the API | \{
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded. Please try again later."
} | | `FrequencyPenalty` | `*float64` | :heavy_check_mark: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | -| `IncompleteDetails` | [*components.IncompleteDetails](../../models/components/incompletedetails.mdx) | :heavy_check_mark: | N/A | \{
"reason": "max_output_tokens"
} | -| `Instructions` | [*components.BaseInputsUnion](../../models/components/baseinputsunion.mdx) | :heavy_check_mark: | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `IncompleteDetails` | [*components.IncompleteDetails](../../models/components/incompletedetails) | :heavy_check_mark: | N/A | \{
"reason": "max_output_tokens"
} | +| `Instructions` | [*components.BaseInputsUnion](../../models/components/baseinputsunion) | :heavy_check_mark: | N/A | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | | `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | | `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | | `Metadata` | map[string]`string` | :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` | [components.OpenResponsesResultObject](../../models/components/openresponsesresultobject.mdx) | :heavy_check_mark: | N/A | | -| `Output` | [][components.OutputItems](../../models/components/outputitems.mdx) | :heavy_check_mark: | N/A | | +| `Object` | [components.OpenResponsesResultObject](../../models/components/openresponsesresultobject) | :heavy_check_mark: | N/A | | +| `Output` | [][components.OutputItems](../../models/components/outputitems) | :heavy_check_mark: | N/A | | | `OutputText` | `*string` | :heavy_minus_sign: | N/A | | | `ParallelToolCalls` | `bool` | :heavy_check_mark: | N/A | | | `PresencePenalty` | `*float64` | :heavy_check_mark: | N/A | | | `PreviousResponseID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate)] | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | | `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/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` | optionalnullable.OptionalNullable[[components.BaseReasoningConfig](../../models/components/basereasoningconfig.mdx)] | :heavy_minus_sign: | N/A | \{
"effort": "medium",
"summary": "auto"
} | +| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions)] | :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` | optionalnullable.OptionalNullable[[components.BaseReasoningConfig](../../models/components/basereasoningconfig)] | :heavy_minus_sign: | N/A | \{
"effort": "medium",
"summary": "auto"
} | | `SafetyIdentifier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `ServiceTier` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | [components.OpenAIResponsesResponseStatus](../../models/components/openairesponsesresponsestatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Status` | [components.OpenAIResponsesResponseStatus](../../models/components/openairesponsesresponsestatus) | :heavy_check_mark: | N/A | completed | | `Store` | `*bool` | :heavy_minus_sign: | N/A | | | `Temperature` | `*float64` | :heavy_check_mark: | N/A | | -| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `ToolChoice` | [components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | :heavy_check_mark: | N/A | auto | -| `Tools` | [][components.OpenResponsesResultToolUnion](../../models/components/openresponsesresulttoolunion.mdx) | :heavy_check_mark: | N/A | | +| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `ToolChoice` | [components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion) | :heavy_check_mark: | N/A | auto | +| `Tools` | [][components.OpenResponsesResultToolUnion](../../models/components/openresponsesresulttoolunion) | :heavy_check_mark: | N/A | | | `TopLogprobs` | `*int64` | :heavy_minus_sign: | N/A | | | `TopP` | `*float64` | :heavy_check_mark: | N/A | | -| `Truncation` | optionalnullable.OptionalNullable[[components.Truncation](../../models/components/truncation.mdx)] | :heavy_minus_sign: | N/A | auto | -| `Usage` | optionalnullable.OptionalNullable[[components.Usage](../../models/components/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
} | +| `Truncation` | optionalnullable.OptionalNullable[[components.Truncation](../../models/components/truncation)] | :heavy_minus_sign: | N/A | auto | +| `Usage` | optionalnullable.OptionalNullable[[components.Usage](../../models/components/usage)] | :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` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype.mdx) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | -| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata.mdx) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"is_byok": false,
"region": "iad",
"requested": "openai/gpt-4o",
"strategy": "direct",
"summary": "available=1, selected=OpenAI"
} | \ No newline at end of file +| `ErrorType` | [*components.APIErrorType](../../models/components/apierrortype) | :heavy_minus_sign: | Canonical OpenRouter error type, stable across all API formats | rate_limit_exceeded | +| `OpenrouterMetadata` | [*components.OpenRouterMetadata](../../models/components/openroutermetadata) | :heavy_minus_sign: | N/A | \{
"attempt": 1,
"endpoints": \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 1
},
"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/components/openresponsesresulttoolfunction.mdx b/docs/models/components/openresponsesresulttoolfunction.mdx index 5af7f389..5829aadc 100644 --- a/docs/models/components/openresponsesresulttoolfunction.mdx +++ b/docs/models/components/openresponsesresulttoolfunction.mdx @@ -13,4 +13,4 @@ Function tool definition | `Name` | `string` | :heavy_check_mark: | N/A | | `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | -| `Type` | [components.OpenResponsesResultType](../../models/components/openresponsesresulttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenResponsesResultType](../../models/components/openresponsesresulttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openrouterfile.mdx b/docs/models/components/openrouterfile.mdx index ec87a628..e50047c6 100644 --- a/docs/models/components/openrouterfile.mdx +++ b/docs/models/components/openrouterfile.mdx @@ -9,11 +9,11 @@ A stored file in the OpenRouter superset shape: Anthropic-shaped, plus OpenRoute | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Shape` | [components.OpenRouterFileShape](../../models/components/openrouterfileshape.mdx) | :heavy_check_mark: | N/A | +| `Shape` | [components.OpenRouterFileShape](../../models/components/openrouterfileshape) | :heavy_check_mark: | N/A | | `CreatedAt` | `string` | :heavy_check_mark: | N/A | | `Downloadable` | `bool` | :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` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenRouterFileType](../../models/components/openrouterfiletype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenRouterFileType](../../models/components/openrouterfiletype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openrouterfiledeleted.mdx b/docs/models/components/openrouterfiledeleted.mdx index 16d6aea4..3b07943b 100644 --- a/docs/models/components/openrouterfiledeleted.mdx +++ b/docs/models/components/openrouterfiledeleted.mdx @@ -9,6 +9,6 @@ Deletion result in the OpenRouter shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Shape` | [components.OpenRouterFileDeletedShape](../../models/components/openrouterfiledeletedshape.mdx) | :heavy_check_mark: | N/A | +| `Shape` | [components.OpenRouterFileDeletedShape](../../models/components/openrouterfiledeletedshape) | :heavy_check_mark: | N/A | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.OpenRouterFileDeletedType](../../models/components/openrouterfiledeletedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OpenRouterFileDeletedType](../../models/components/openrouterfiledeletedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openrouterfilelist.mdx b/docs/models/components/openrouterfilelist.mdx index 8b4ef8de..a83a9f53 100644 --- a/docs/models/components/openrouterfilelist.mdx +++ b/docs/models/components/openrouterfilelist.mdx @@ -9,9 +9,9 @@ A page of files in the OpenRouter shape. | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `Shape` | [components.OpenRouterFileListShape](../../models/components/openrouterfilelistshape.mdx) | :heavy_check_mark: | N/A | +| `Shape` | [components.OpenRouterFileListShape](../../models/components/openrouterfilelistshape) | :heavy_check_mark: | N/A | | `Cursor` | `*string` | :heavy_check_mark: | Opaque cursor for the next page; null when there are no more results. | -| `Data` | [][components.OpenRouterFile](../../models/components/openrouterfile.mdx) | :heavy_check_mark: | N/A | +| `Data` | [][components.OpenRouterFile](../../models/components/openrouterfile) | :heavy_check_mark: | N/A | | `FirstID` | `*string` | :heavy_check_mark: | N/A | | `HasMore` | `bool` | :heavy_check_mark: | N/A | | `LastID` | `*string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/openroutermetadata.mdx b/docs/models/components/openroutermetadata.mdx index eb48ef08..32ed9c72 100644 --- a/docs/models/components/openroutermetadata.mdx +++ b/docs/models/components/openroutermetadata.mdx @@ -7,12 +7,12 @@ title: "OpenRouterMetadata" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `Attempt` | `int64` | :heavy_check_mark: | N/A | | -| `Attempts` | [][components.RouterAttempt](../../models/components/routerattempt.mdx) | :heavy_minus_sign: | N/A | | -| `Endpoints` | [components.EndpointsMetadata](../../models/components/endpointsmetadata.mdx) | :heavy_check_mark: | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | +| `Attempts` | [][components.RouterAttempt](../../models/components/routerattempt) | :heavy_minus_sign: | N/A | | +| `Endpoints` | [components.EndpointsMetadata](../../models/components/endpointsmetadata) | :heavy_check_mark: | N/A | \{
"available": [
\{
"model": "openai/gpt-4o",
"provider": "OpenAI",
"selected": true
}
],
"total": 3
} | | `IsByok` | `bool` | :heavy_check_mark: | N/A | | -| `Params` | [*components.RouterParams](../../models/components/routerparams.mdx) | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | -| `Pipeline` | [][components.PipelineStage](../../models/components/pipelinestage.mdx) | :heavy_minus_sign: | N/A | | +| `Params` | [*components.RouterParams](../../models/components/routerparams) | :heavy_minus_sign: | N/A | \{
"version_group": "anthropic/claude-sonnet-4"
} | +| `Pipeline` | [][components.PipelineStage](../../models/components/pipelinestage) | :heavy_minus_sign: | N/A | | | `Region` | `*string` | :heavy_check_mark: | N/A | | | `Requested` | `string` | :heavy_check_mark: | N/A | | -| `Strategy` | [components.RoutingStrategy](../../models/components/routingstrategy.mdx) | :heavy_check_mark: | N/A | direct | +| `Strategy` | [components.RoutingStrategy](../../models/components/routingstrategy) | :heavy_check_mark: | N/A | direct | | `Summary` | `string` | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/openrouterwebsearchservertool.mdx b/docs/models/components/openrouterwebsearchservertool.mdx index acd808b4..fd5fe724 100644 --- a/docs/models/components/openrouterwebsearchservertool.mdx +++ b/docs/models/components/openrouterwebsearchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig.mdx) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `Type` | [components.OpenRouterWebSearchServerToolType](../../models/components/openrouterwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.WebSearchConfig](../../models/components/websearchconfig) | :heavy_minus_sign: | N/A | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `Type` | [components.OpenRouterWebSearchServerToolType](../../models/components/openrouterwebsearchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outcomeexit.mdx b/docs/models/components/outcomeexit.mdx index 855c048d..2fef2df4 100644 --- a/docs/models/components/outcomeexit.mdx +++ b/docs/models/components/outcomeexit.mdx @@ -7,4 +7,4 @@ title: "OutcomeExit" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `ExitCode` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeExit](../../models/components/typeexit.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeExit](../../models/components/typeexit) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outcometimeout.mdx b/docs/models/components/outcometimeout.mdx index 76f141aa..62f8664b 100644 --- a/docs/models/components/outcometimeout.mdx +++ b/docs/models/components/outcometimeout.mdx @@ -6,4 +6,4 @@ title: "OutcomeTimeout" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Type` | [components.TypeTimeout](../../models/components/typetimeout.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeTimeout](../../models/components/typetimeout) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputadvisorservertoolitem.mdx b/docs/models/components/outputadvisorservertoolitem.mdx index e9fd6488..66246627 100644 --- a/docs/models/components/outputadvisorservertoolitem.mdx +++ b/docs/models/components/outputadvisorservertoolitem.mdx @@ -15,5 +15,5 @@ An openrouter:advisor server tool output item | `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` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputAdvisorServerToolItemType](../../models/components/outputadvisorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputAdvisorServerToolItemType](../../models/components/outputadvisorservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputapplypatchcallitem.mdx b/docs/models/components/outputapplypatchcallitem.mdx index fba57735..8d86151c 100644 --- a/docs/models/components/outputapplypatchcallitem.mdx +++ b/docs/models/components/outputapplypatchcallitem.mdx @@ -11,6 +11,6 @@ A native `apply_patch_call` output item matching OpenAI's Responses API shape. E | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `CallID` | `string` | :heavy_check_mark: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | -| `Operation` | [components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | :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` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus.mdx) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | -| `Type` | [components.OutputApplyPatchCallItemType](../../models/components/outputapplypatchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Operation` | [components.ApplyPatchCallOperation](../../models/components/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` | [components.ApplyPatchCallStatus](../../models/components/applypatchcallstatus) | :heavy_check_mark: | Lifecycle state of an `apply_patch_call` output item. | completed | +| `Type` | [components.OutputApplyPatchCallItemType](../../models/components/outputapplypatchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputapplypatchservertoolitem.mdx b/docs/models/components/outputapplypatchservertoolitem.mdx index 15ebca23..33da9724 100644 --- a/docs/models/components/outputapplypatchservertoolitem.mdx +++ b/docs/models/components/outputapplypatchservertoolitem.mdx @@ -11,6 +11,6 @@ An openrouter:apply_patch server tool output item. The turn halts when validatio | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | `CallID` | `*string` | :heavy_minus_sign: | N/A | | | `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Operation` | [*components.ApplyPatchCallOperation](../../models/components/applypatchcalloperation.mdx) | :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` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputApplyPatchServerToolItemType](../../models/components/outputapplypatchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Operation` | [*components.ApplyPatchCallOperation](../../models/components/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` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputApplyPatchServerToolItemType](../../models/components/outputapplypatchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputbashservertoolitem.mdx b/docs/models/components/outputbashservertoolitem.mdx index ede0fd6b..26461160 100644 --- a/docs/models/components/outputbashservertoolitem.mdx +++ b/docs/models/components/outputbashservertoolitem.mdx @@ -14,7 +14,7 @@ An openrouter:bash server tool output item | `Command` | `*string` | :heavy_minus_sign: | N/A | | | `ExitCode` | `*int64` | :heavy_minus_sign: | N/A | | | `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `Stderr` | `*string` | :heavy_minus_sign: | N/A | | | `Stdout` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputBashServerToolItemType](../../models/components/outputbashservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.OutputBashServerToolItemType](../../models/components/outputbashservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputbrowseruseservertoolitem.mdx b/docs/models/components/outputbrowseruseservertoolitem.mdx index 25673e0f..4cb3ed8d 100644 --- a/docs/models/components/outputbrowseruseservertoolitem.mdx +++ b/docs/models/components/outputbrowseruseservertoolitem.mdx @@ -12,5 +12,5 @@ An openrouter:browser_use server tool output item | `Action` | `*string` | :heavy_minus_sign: | N/A | | | `ID` | `*string` | :heavy_minus_sign: | N/A | | | `ScreenshotB64` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputBrowserUseServerToolItemType](../../models/components/outputbrowseruseservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputBrowserUseServerToolItemType](../../models/components/outputbrowseruseservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputcodeinterpretercallitem.mdx b/docs/models/components/outputcodeinterpretercallitem.mdx index 2c194047..fbce5c21 100644 --- a/docs/models/components/outputcodeinterpretercallitem.mdx +++ b/docs/models/components/outputcodeinterpretercallitem.mdx @@ -12,6 +12,6 @@ A code interpreter execution call with outputs | `Code` | `*string` | :heavy_check_mark: | N/A | | | `ContainerID` | `string` | :heavy_check_mark: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | -| `Outputs` | [][components.OutputCodeInterpreterCallItemOutputUnion](../../models/components/outputcodeinterpretercallitemoutputunion.mdx) | :heavy_check_mark: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.TypeCodeInterpreterCall](../../models/components/typecodeinterpretercall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Outputs` | [][components.OutputCodeInterpreterCallItemOutputUnion](../../models/components/outputcodeinterpretercallitemoutputunion) | :heavy_check_mark: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.TypeCodeInterpreterCall](../../models/components/typecodeinterpretercall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputcodeinterpreterservertoolitem.mdx b/docs/models/components/outputcodeinterpreterservertoolitem.mdx index 43f758a5..f9bb2f58 100644 --- a/docs/models/components/outputcodeinterpreterservertoolitem.mdx +++ b/docs/models/components/outputcodeinterpreterservertoolitem.mdx @@ -13,7 +13,7 @@ An openrouter:code_interpreter server tool output item | `ExitCode` | `*int64` | :heavy_minus_sign: | N/A | | | `ID` | `*string` | :heavy_minus_sign: | N/A | | | `Language` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `Stderr` | `*string` | :heavy_minus_sign: | N/A | | | `Stdout` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputCodeInterpreterServerToolItemType](../../models/components/outputcodeinterpreterservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.OutputCodeInterpreterServerToolItemType](../../models/components/outputcodeinterpreterservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputcomputercallitem.mdx b/docs/models/components/outputcomputercallitem.mdx index f6342077..705095ea 100644 --- a/docs/models/components/outputcomputercallitem.mdx +++ b/docs/models/components/outputcomputercallitem.mdx @@ -9,6 +9,6 @@ title: "OutputComputerCallItem" | `Action` | `any` | :heavy_minus_sign: | N/A | | `CallID` | `string` | :heavy_check_mark: | N/A | | `ID` | `*string` | :heavy_minus_sign: | N/A | -| `PendingSafetyChecks` | [][components.PendingSafetyCheck](../../models/components/pendingsafetycheck.mdx) | :heavy_check_mark: | N/A | -| `Status` | [components.OutputComputerCallItemStatus](../../models/components/outputcomputercallitemstatus.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.OutputComputerCallItemType](../../models/components/outputcomputercallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `PendingSafetyChecks` | [][components.PendingSafetyCheck](../../models/components/pendingsafetycheck) | :heavy_check_mark: | N/A | +| `Status` | [components.OutputComputerCallItemStatus](../../models/components/outputcomputercallitemstatus) | :heavy_check_mark: | N/A | +| `Type` | [components.OutputComputerCallItemType](../../models/components/outputcomputercallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputcustomtoolcallitem.mdx b/docs/models/components/outputcustomtoolcallitem.mdx index a70158da..4745f5e1 100644 --- a/docs/models/components/outputcustomtoolcallitem.mdx +++ b/docs/models/components/outputcustomtoolcallitem.mdx @@ -14,4 +14,4 @@ A call to a custom (freeform-grammar) tool created by the model — distinct fro | `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` | [components.OutputCustomToolCallItemType](../../models/components/outputcustomtoolcallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.OutputCustomToolCallItemType](../../models/components/outputcustomtoolcallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputdatetimeitem.mdx b/docs/models/components/outputdatetimeitem.mdx index c831bb78..f92746b9 100644 --- a/docs/models/components/outputdatetimeitem.mdx +++ b/docs/models/components/outputdatetimeitem.mdx @@ -11,6 +11,6 @@ An openrouter:datetime server tool output item | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `Datetime` | `string` | :heavy_check_mark: | ISO 8601 datetime string | | | `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `Timezone` | `string` | :heavy_check_mark: | IANA timezone name | | -| `Type` | [components.OutputDatetimeItemType](../../models/components/outputdatetimeitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.OutputDatetimeItemType](../../models/components/outputdatetimeitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfilesearchcallitem.mdx b/docs/models/components/outputfilesearchcallitem.mdx index 7ec3d6c6..aef96657 100644 --- a/docs/models/components/outputfilesearchcallitem.mdx +++ b/docs/models/components/outputfilesearchcallitem.mdx @@ -8,5 +8,5 @@ title: "OutputFileSearchCallItem" | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | N/A | | | `Queries` | []`string` | :heavy_check_mark: | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFileSearchCallItemType](../../models/components/outputfilesearchcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputFileSearchCallItemType](../../models/components/outputfilesearchcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfilesearchservertoolitem.mdx b/docs/models/components/outputfilesearchservertoolitem.mdx index 74dcebbe..75a0887a 100644 --- a/docs/models/components/outputfilesearchservertoolitem.mdx +++ b/docs/models/components/outputfilesearchservertoolitem.mdx @@ -11,5 +11,5 @@ An openrouter:file_search server tool output item | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `ID` | `*string` | :heavy_minus_sign: | N/A | | | `Queries` | []`string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFileSearchServerToolItemType](../../models/components/outputfilesearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputFileSearchServerToolItemType](../../models/components/outputfilesearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfilesservertoolitem.mdx b/docs/models/components/outputfilesservertoolitem.mdx index 78d58b1b..b398d390 100644 --- a/docs/models/components/outputfilesservertoolitem.mdx +++ b/docs/models/components/outputfilesservertoolitem.mdx @@ -15,5 +15,5 @@ An openrouter:files server tool output item | `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` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFilesServerToolItemType](../../models/components/outputfilesservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputFilesServerToolItemType](../../models/components/outputfilesservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputfunctioncallitem.mdx b/docs/models/components/outputfunctioncallitem.mdx index 299310e3..9a4cddcc 100644 --- a/docs/models/components/outputfunctioncallitem.mdx +++ b/docs/models/components/outputfunctioncallitem.mdx @@ -11,5 +11,5 @@ title: "OutputFunctionCallItem" | `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` | [*components.OutputFunctionCallItemStatusUnion](../../models/components/outputfunctioncallitemstatusunion.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputFunctionCallItemType](../../models/components/outputfunctioncallitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Status` | [*components.OutputFunctionCallItemStatusUnion](../../models/components/outputfunctioncallitemstatusunion) | :heavy_minus_sign: | N/A | +| `Type` | [components.OutputFunctionCallItemType](../../models/components/outputfunctioncallitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputfusionservertoolitem.mdx b/docs/models/components/outputfusionservertoolitem.mdx index ced5bc68..47205e3d 100644 --- a/docs/models/components/outputfusionservertoolitem.mdx +++ b/docs/models/components/outputfusionservertoolitem.mdx @@ -9,12 +9,12 @@ An openrouter:fusion server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Analysis` | [*components.FusionAnalysisResult](../../models/components/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"
}
]
} | +| `Analysis` | [*components.FusionAnalysisResult](../../models/components/fusionanalysisresult) | :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` | [][components.FailedModel](../../models/components/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. The fusion result is still usable but was produced from a degraded panel. | | +| `FailedModels` | [][components.FailedModel](../../models/components/failedmodel) | :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. The fusion result is still usable but was produced from a degraded panel. | | | `FailureReason` | `*string` | :heavy_minus_sign: | Typed failure reason when the fusion run failed. Possible values include: all_panels_failed, insufficient_credits, rate_limited, 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. | | | `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Responses` | [][components.Response](../../models/components/response.mdx) | :heavy_minus_sign: | Analysis models that produced a response in this fusion run, with each model's full panel content. | | -| `Sources` | [][components.FusionSource](../../models/components/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` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputFusionServerToolItemType](../../models/components/outputfusionservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Responses` | [][components.Response](../../models/components/response) | :heavy_minus_sign: | Analysis models that produced a response in this fusion run, with each model's full panel content. | | +| `Sources` | [][components.FusionSource](../../models/components/fusionsource) | :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` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputFusionServerToolItemType](../../models/components/outputfusionservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputimage.mdx b/docs/models/components/outputimage.mdx index 6e58ba16..ed6f7235 100644 --- a/docs/models/components/outputimage.mdx +++ b/docs/models/components/outputimage.mdx @@ -6,5 +6,5 @@ title: "OutputImage" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `Type` | [components.OutputCodeInterpreterCallItemTypeImage](../../models/components/outputcodeinterpretercallitemtypeimage.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.OutputCodeInterpreterCallItemTypeImage](../../models/components/outputcodeinterpretercallitemtypeimage) | :heavy_check_mark: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputimagegenerationcallitem.mdx b/docs/models/components/outputimagegenerationcallitem.mdx index 9bd9a25d..15c34fc0 100644 --- a/docs/models/components/outputimagegenerationcallitem.mdx +++ b/docs/models/components/outputimagegenerationcallitem.mdx @@ -8,6 +8,6 @@ title: "OutputImageGenerationCallItem" | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `ID` | `string` | :heavy_check_mark: | N/A | | | `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputImageGenerationCallItemType](../../models/components/outputimagegenerationcallitemtype.mdx) | :heavy_check_mark: | N/A | | +| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputImageGenerationCallItemType](../../models/components/outputimagegenerationcallitemtype) | :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 diff --git a/docs/models/components/outputimagegenerationservertoolitem.mdx b/docs/models/components/outputimagegenerationservertoolitem.mdx index 39c6b62b..f809040a 100644 --- a/docs/models/components/outputimagegenerationservertoolitem.mdx +++ b/docs/models/components/outputimagegenerationservertoolitem.mdx @@ -15,5 +15,5 @@ An openrouter:image_generation server tool output item | `Prompt` | `*string` | :heavy_minus_sign: | The prompt (possibly rewritten) that the image was generated from. | | | `Result` | optionalnullable.OptionalNullable[`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` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputImageGenerationServerToolItemType](../../models/components/outputimagegenerationservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputImageGenerationServerToolItemType](../../models/components/outputimagegenerationservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputitemimagegenerationcall.mdx b/docs/models/components/outputitemimagegenerationcall.mdx index 5f80bfc7..17963882 100644 --- a/docs/models/components/outputitemimagegenerationcall.mdx +++ b/docs/models/components/outputitemimagegenerationcall.mdx @@ -8,5 +8,5 @@ title: "OutputItemImageGenerationCall" | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `ID` | `string` | :heavy_check_mark: | N/A | | | `Result` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputItemImageGenerationCallType](../../models/components/outputitemimagegenerationcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ImageGenerationStatus](../../models/components/imagegenerationstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputItemImageGenerationCallType](../../models/components/outputitemimagegenerationcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputlogs.mdx b/docs/models/components/outputlogs.mdx index fd31ebec..3af092e1 100644 --- a/docs/models/components/outputlogs.mdx +++ b/docs/models/components/outputlogs.mdx @@ -7,4 +7,4 @@ title: "OutputLogs" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `Logs` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeLogs](../../models/components/typelogs.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeLogs](../../models/components/typelogs) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputmcpservertoolitem.mdx b/docs/models/components/outputmcpservertoolitem.mdx index bc7aa85c..76334093 100644 --- a/docs/models/components/outputmcpservertoolitem.mdx +++ b/docs/models/components/outputmcpservertoolitem.mdx @@ -11,6 +11,6 @@ An openrouter:mcp server tool output item | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | | `ID` | `*string` | :heavy_minus_sign: | N/A | | | `ServerLabel` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `ToolName` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputMcpServerToolItemType](../../models/components/outputmcpservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.OutputMcpServerToolItemType](../../models/components/outputmcpservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputmemoryservertoolitem.mdx b/docs/models/components/outputmemoryservertoolitem.mdx index 09b7e5ec..a2af5ff4 100644 --- a/docs/models/components/outputmemoryservertoolitem.mdx +++ b/docs/models/components/outputmemoryservertoolitem.mdx @@ -9,9 +9,9 @@ An openrouter:memory server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Action` | [*components.ActionEnum](../../models/components/actionenum.mdx) | :heavy_minus_sign: | N/A | | +| `Action` | [*components.ActionEnum](../../models/components/actionenum) | :heavy_minus_sign: | N/A | | | `ID` | `*string` | :heavy_minus_sign: | N/A | | | `Key` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputMemoryServerToolItemType](../../models/components/outputmemoryservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputMemoryServerToolItemType](../../models/components/outputmemoryservertoolitemtype) | :heavy_check_mark: | N/A | | | `Value` | `any` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputmessage.mdx b/docs/models/components/outputmessage.mdx index ce33cc76..1edd7831 100644 --- a/docs/models/components/outputmessage.mdx +++ b/docs/models/components/outputmessage.mdx @@ -6,9 +6,9 @@ title: "OutputMessage" | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.OutputMessageContent](../../models/components/outputmessagecontent.mdx) | :heavy_check_mark: | N/A | +| `Content` | [][components.OutputMessageContent](../../models/components/outputmessagecontent) | :heavy_check_mark: | N/A | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessagePhaseUnion](../../models/components/outputmessagephaseunion.mdx)] | :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` | [components.OutputMessageRole](../../models/components/outputmessagerole.mdx) | :heavy_check_mark: | N/A | -| `Status` | [*components.OutputMessageStatusUnion](../../models/components/outputmessagestatusunion.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputMessageType](../../models/components/outputmessagetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessagePhaseUnion](../../models/components/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` | [components.OutputMessageRole](../../models/components/outputmessagerole) | :heavy_check_mark: | N/A | +| `Status` | [*components.OutputMessageStatusUnion](../../models/components/outputmessagestatusunion) | :heavy_minus_sign: | N/A | +| `Type` | [components.OutputMessageType](../../models/components/outputmessagetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputmessageitem.mdx b/docs/models/components/outputmessageitem.mdx index 4a1ee603..4012878b 100644 --- a/docs/models/components/outputmessageitem.mdx +++ b/docs/models/components/outputmessageitem.mdx @@ -9,9 +9,9 @@ An output message item | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Content` | [][components.OutputMessageItemContent](../../models/components/outputmessageitemcontent.mdx) | :heavy_check_mark: | N/A | +| `Content` | [][components.OutputMessageItemContent](../../models/components/outputmessageitemcontent) | :heavy_check_mark: | N/A | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessageItemPhaseUnion](../../models/components/outputmessageitemphaseunion.mdx)] | :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` | [components.OutputMessageItemRole](../../models/components/outputmessageitemrole.mdx) | :heavy_check_mark: | N/A | -| `Status` | [*components.OutputMessageItemStatusUnion](../../models/components/outputmessageitemstatusunion.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputMessageItemType](../../models/components/outputmessageitemtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Phase` | optionalnullable.OptionalNullable[[components.OutputMessageItemPhaseUnion](../../models/components/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` | [components.OutputMessageItemRole](../../models/components/outputmessageitemrole) | :heavy_check_mark: | N/A | +| `Status` | [*components.OutputMessageItemStatusUnion](../../models/components/outputmessageitemstatusunion) | :heavy_minus_sign: | N/A | +| `Type` | [components.OutputMessageItemType](../../models/components/outputmessageitemtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputreasoningitem.mdx b/docs/models/components/outputreasoningitem.mdx index 05843b63..a652ddb1 100644 --- a/docs/models/components/outputreasoningitem.mdx +++ b/docs/models/components/outputreasoningitem.mdx @@ -9,11 +9,11 @@ An output item containing reasoning | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent)] | :heavy_minus_sign: | N/A | | | `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [*components.OutputReasoningItemStatusUnion](../../models/components/outputreasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.OutputReasoningItemType](../../models/components/outputreasoningitemtype.mdx) | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Status` | [*components.OutputReasoningItemStatusUnion](../../models/components/outputreasoningitemstatusunion) | :heavy_minus_sign: | N/A | | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext) | :heavy_check_mark: | N/A | | +| `Type` | [components.OutputReasoningItemType](../../models/components/outputreasoningitemtype) | :heavy_check_mark: | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat)] | :heavy_minus_sign: | N/A | unknown | | `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | A signature for the reasoning content, used for verification | EvcBCkgIChABGAIqQKkSDbRuVEQUk9qN1odC098l9SEj... | \ No newline at end of file diff --git a/docs/models/components/outputsearchmodelsservertoolitem.mdx b/docs/models/components/outputsearchmodelsservertoolitem.mdx index 331e79a1..8a29380d 100644 --- a/docs/models/components/outputsearchmodelsservertoolitem.mdx +++ b/docs/models/components/outputsearchmodelsservertoolitem.mdx @@ -12,5 +12,5 @@ An openrouter:experimental__search_models server tool output item | `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` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputSearchModelsServerToolItemType](../../models/components/outputsearchmodelsservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputSearchModelsServerToolItemType](../../models/components/outputsearchmodelsservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellcallitem.mdx b/docs/models/components/outputshellcallitem.mdx index c103a28c..92b953a2 100644 --- a/docs/models/components/outputshellcallitem.mdx +++ b/docs/models/components/outputshellcallitem.mdx @@ -9,8 +9,8 @@ A native `shell_call` output item matching OpenAI's Responses API shape. Emitted | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `Action` | [*components.OutputShellCallItemAction](../../models/components/outputshellcallitemaction.mdx) | :heavy_minus_sign: | N/A | | +| `Action` | [*components.OutputShellCallItemAction](../../models/components/outputshellcallitemaction) | :heavy_minus_sign: | N/A | | | `CallID` | `string` | :heavy_check_mark: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | -| `Type` | [components.OutputShellCallItemType](../../models/components/outputshellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus) | :heavy_check_mark: | Status of a shell call or its output. | completed | +| `Type` | [components.OutputShellCallItemType](../../models/components/outputshellcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellcalloutputitem.mdx b/docs/models/components/outputshellcalloutputitem.mdx index 94ed03cb..70140e06 100644 --- a/docs/models/components/outputshellcalloutputitem.mdx +++ b/docs/models/components/outputshellcalloutputitem.mdx @@ -12,6 +12,6 @@ A native `shell_call_output` item matching OpenAI's Responses API shape. Carries | `CallID` | `string` | :heavy_check_mark: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | | `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Output` | [][components.OutputShellCallOutputItemOutput](../../models/components/outputshellcalloutputitemoutput.mdx) | :heavy_check_mark: | N/A | | -| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus.mdx) | :heavy_check_mark: | Status of a shell call or its output. | completed | -| `Type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../../models/components/outputshellcalloutputitemtypeshellcalloutput.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Output` | [][components.OutputShellCallOutputItemOutput](../../models/components/outputshellcalloutputitemoutput) | :heavy_check_mark: | N/A | | +| `Status` | [components.ShellCallStatus](../../models/components/shellcallstatus) | :heavy_check_mark: | Status of a shell call or its output. | completed | +| `Type` | [components.OutputShellCallOutputItemTypeShellCallOutput](../../models/components/outputshellcalloutputitemtypeshellcalloutput) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputshellcalloutputitemoutput.mdx b/docs/models/components/outputshellcalloutputitemoutput.mdx index cc6f1780..58718bbe 100644 --- a/docs/models/components/outputshellcalloutputitemoutput.mdx +++ b/docs/models/components/outputshellcalloutputitemoutput.mdx @@ -6,6 +6,6 @@ title: "OutputShellCallOutputItemOutput" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `Outcome` | [components.Outcome](../../models/components/outcome.mdx) | :heavy_check_mark: | N/A | +| `Outcome` | [components.Outcome](../../models/components/outcome) | :heavy_check_mark: | N/A | | `Stderr` | `string` | :heavy_check_mark: | N/A | | `Stdout` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputsubagentservertoolitem.mdx b/docs/models/components/outputsubagentservertoolitem.mdx index 4a60ff87..094df806 100644 --- a/docs/models/components/outputsubagentservertoolitem.mdx +++ b/docs/models/components/outputsubagentservertoolitem.mdx @@ -15,7 +15,7 @@ An openrouter:subagent server tool output item | `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` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :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` | [components.OutputSubagentServerToolItemType](../../models/components/outputsubagentservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.OutputSubagentServerToolItemType](../../models/components/outputsubagentservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputtexteditorservertoolitem.mdx b/docs/models/components/outputtexteditorservertoolitem.mdx index 039f5e00..23a69c21 100644 --- a/docs/models/components/outputtexteditorservertoolitem.mdx +++ b/docs/models/components/outputtexteditorservertoolitem.mdx @@ -9,8 +9,8 @@ An openrouter:text_editor server tool output item | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -| `Command` | [*components.Command](../../models/components/command.mdx) | :heavy_minus_sign: | N/A | | +| `Command` | [*components.Command](../../models/components/command) | :heavy_minus_sign: | N/A | | | `FilePath` | `*string` | :heavy_minus_sign: | N/A | | | `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputTextEditorServerToolItemType](../../models/components/outputtexteditorservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputTextEditorServerToolItemType](../../models/components/outputtexteditorservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputtoolsearchservertoolitem.mdx b/docs/models/components/outputtoolsearchservertoolitem.mdx index 3829a775..2fc214d0 100644 --- a/docs/models/components/outputtoolsearchservertoolitem.mdx +++ b/docs/models/components/outputtoolsearchservertoolitem.mdx @@ -11,5 +11,5 @@ An openrouter:tool_search server tool output item | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `ID` | `*string` | :heavy_minus_sign: | N/A | | | `Query` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputToolSearchServerToolItemType](../../models/components/outputtoolsearchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputToolSearchServerToolItemType](../../models/components/outputtoolsearchservertoolitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebfetchservertoolitem.mdx b/docs/models/components/outputwebfetchservertoolitem.mdx index 181609b0..6cbe316f 100644 --- a/docs/models/components/outputwebfetchservertoolitem.mdx +++ b/docs/models/components/outputwebfetchservertoolitem.mdx @@ -13,7 +13,7 @@ An openrouter:web_fetch server tool output item | `Error` | `*string` | :heavy_minus_sign: | The error message if the fetch failed. | | | `HTTPStatus` | `*int64` | :heavy_minus_sign: | The HTTP status code returned by the upstream URL fetch. | | | `ID` | `*string` | :heavy_minus_sign: | N/A | | -| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | | `Title` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.OutputWebFetchServerToolItemType](../../models/components/outputwebfetchservertoolitemtype.mdx) | :heavy_check_mark: | N/A | | +| `Type` | [components.OutputWebFetchServerToolItemType](../../models/components/outputwebfetchservertoolitemtype) | :heavy_check_mark: | N/A | | | `URL` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitem.mdx b/docs/models/components/outputwebsearchcallitem.mdx index 9161ed2c..2c451400 100644 --- a/docs/models/components/outputwebsearchcallitem.mdx +++ b/docs/models/components/outputwebsearchcallitem.mdx @@ -6,7 +6,7 @@ title: "OutputWebSearchCallItem" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Action` | [*components.Action](../../models/components/action.mdx) | :heavy_minus_sign: | N/A | | +| `Action` | [*components.Action](../../models/components/action) | :heavy_minus_sign: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.TypeWebSearchCall](../../models/components/typewebsearchcall.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.WebSearchStatus](../../models/components/websearchstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.TypeWebSearchCall](../../models/components/typewebsearchcall) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchcallitemactionsearch.mdx b/docs/models/components/outputwebsearchcallitemactionsearch.mdx index 072414a2..dfe5f839 100644 --- a/docs/models/components/outputwebsearchcallitemactionsearch.mdx +++ b/docs/models/components/outputwebsearchcallitemactionsearch.mdx @@ -8,5 +8,5 @@ title: "OutputWebSearchCallItemActionSearch" | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `Queries` | []`string` | :heavy_minus_sign: | N/A | | `Query` | `string` | :heavy_check_mark: | N/A | -| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.ActionTypeSearch](../../models/components/actiontypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Sources` | [][components.WebSearchSource](../../models/components/websearchsource) | :heavy_minus_sign: | N/A | +| `Type` | [components.ActionTypeSearch](../../models/components/actiontypesearch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchservertoolitem.mdx b/docs/models/components/outputwebsearchservertoolitem.mdx index b6bfd24a..a617bc43 100644 --- a/docs/models/components/outputwebsearchservertoolitem.mdx +++ b/docs/models/components/outputwebsearchservertoolitem.mdx @@ -9,7 +9,7 @@ An openrouter:web_search server tool output item | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Action` | [*components.OutputWebSearchServerToolItemAction](../../models/components/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. | | +| `Action` | [*components.OutputWebSearchServerToolItemAction](../../models/components/outputwebsearchservertoolitemaction) | :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` | [components.ToolCallStatus](../../models/components/toolcallstatus.mdx) | :heavy_check_mark: | N/A | completed | -| `Type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../../models/components/outputwebsearchservertoolitemtypeopenrouterwebsearch.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | [components.ToolCallStatus](../../models/components/toolcallstatus) | :heavy_check_mark: | N/A | completed | +| `Type` | [components.OutputWebSearchServerToolItemTypeOpenrouterWebSearch](../../models/components/outputwebsearchservertoolitemtypeopenrouterwebsearch) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchservertoolitemaction.mdx b/docs/models/components/outputwebsearchservertoolitemaction.mdx index f48fb201..54bd10a2 100644 --- a/docs/models/components/outputwebsearchservertoolitemaction.mdx +++ b/docs/models/components/outputwebsearchservertoolitemaction.mdx @@ -10,5 +10,5 @@ The search action performed, matching OpenAI web_search_call.action shape. Inclu | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | `Query` | `string` | :heavy_check_mark: | N/A | -| `Sources` | [][components.OutputWebSearchServerToolItemSource](../../models/components/outputwebsearchservertoolitemsource.mdx) | :heavy_minus_sign: | N/A | -| `Type` | [components.OutputWebSearchServerToolItemTypeSearch](../../models/components/outputwebsearchservertoolitemtypesearch.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Sources` | [][components.OutputWebSearchServerToolItemSource](../../models/components/outputwebsearchservertoolitemsource) | :heavy_minus_sign: | N/A | +| `Type` | [components.OutputWebSearchServerToolItemTypeSearch](../../models/components/outputwebsearchservertoolitemtypesearch) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/outputwebsearchservertoolitemsource.mdx b/docs/models/components/outputwebsearchservertoolitemsource.mdx index a674d64a..7943109e 100644 --- a/docs/models/components/outputwebsearchservertoolitemsource.mdx +++ b/docs/models/components/outputwebsearchservertoolitemsource.mdx @@ -6,5 +6,5 @@ title: "OutputWebSearchServerToolItemSource" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Type` | [components.OutputWebSearchServerToolItemTypeURL](../../models/components/outputwebsearchservertoolitemtypeurl.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.OutputWebSearchServerToolItemTypeURL](../../models/components/outputwebsearchservertoolitemtypeurl) | :heavy_check_mark: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/paretorouterplugin.mdx b/docs/models/components/paretorouterplugin.mdx index c499f4b7..56a5bc4b 100644 --- a/docs/models/components/paretorouterplugin.mdx +++ b/docs/models/components/paretorouterplugin.mdx @@ -7,7 +7,7 @@ title: "ParetoRouterPlugin" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the pareto-router plugin for this request. Defaults to true. | | -| `ID` | [components.ParetoRouterPluginID](../../models/components/paretorouterpluginid.mdx) | :heavy_check_mark: | N/A | | +| `ID` | [components.ParetoRouterPluginID](../../models/components/paretorouterpluginid) | :heavy_check_mark: | N/A | | | `MaxPrice` | `*float64` | :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` | `*float64` | :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` | [*components.PriceSource](../../models/components/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 +| `PriceSource` | [*components.PriceSource](../../models/components/pricesource) | :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 diff --git a/docs/models/components/pdfparseroptions.mdx b/docs/models/components/pdfparseroptions.mdx index 7065b065..57f08b95 100644 --- a/docs/models/components/pdfparseroptions.mdx +++ b/docs/models/components/pdfparseroptions.mdx @@ -9,4 +9,4 @@ Options for PDF parsing. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.PDFParserEngine](../../models/components/pdfparserengine.mdx) | :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` | [*components.PDFParserEngine](../../models/components/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 diff --git a/docs/models/components/pipelinestage.mdx b/docs/models/components/pipelinestage.mdx index ced1b8f8..16cc58ea 100644 --- a/docs/models/components/pipelinestage.mdx +++ b/docs/models/components/pipelinestage.mdx @@ -12,4 +12,4 @@ title: "PipelineStage" | `GuardrailScope` | `*string` | :heavy_minus_sign: | N/A | | | `Name` | `string` | :heavy_check_mark: | N/A | | | `Summary` | `*string` | :heavy_minus_sign: | N/A | | -| `Type` | [components.PipelineStageType](../../models/components/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 +| `Type` | [components.PipelineStageType](../../models/components/pipelinestagetype) | :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 diff --git a/docs/models/components/prediction.mdx b/docs/models/components/prediction.mdx index 5cbb8207..7029f7d7 100644 --- a/docs/models/components/prediction.mdx +++ b/docs/models/components/prediction.mdx @@ -9,5 +9,5 @@ Static predicted output content. Supported models can use this to reduce latency | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `Content` | [components.PredictionContent](../../models/components/predictioncontent.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.PredictionType](../../models/components/predictiontype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [components.PredictionContent](../../models/components/predictioncontent) | :heavy_check_mark: | N/A | +| `Type` | [components.PredictionType](../../models/components/predictiontype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/predictioncontenttext.mdx b/docs/models/components/predictioncontenttext.mdx index d28120b6..d8d96af9 100644 --- a/docs/models/components/predictioncontenttext.mdx +++ b/docs/models/components/predictioncontenttext.mdx @@ -10,4 +10,4 @@ Text content part for a predicted output. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.PredictionContentTextType](../../models/components/predictioncontenttexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.PredictionContentTextType](../../models/components/predictioncontenttexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/preset.mdx b/docs/models/components/preset.mdx index 33eec201..bacae270 100644 --- a/docs/models/components/preset.mdx +++ b/docs/models/components/preset.mdx @@ -16,7 +16,7 @@ A preset without version details. | `ID` | `string` | :heavy_check_mark: | N/A | | | `Name` | `string` | :heavy_check_mark: | N/A | | | `Slug` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | +| `Status` | [components.PresetStatus](../../models/components/presetstatus) | :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 diff --git a/docs/models/components/presetwithdesignatedversion.mdx b/docs/models/components/presetwithdesignatedversion.mdx index bec3d33f..85526757 100644 --- a/docs/models/components/presetwithdesignatedversion.mdx +++ b/docs/models/components/presetwithdesignatedversion.mdx @@ -16,8 +16,8 @@ A preset with its currently designated version. | `ID` | `string` | :heavy_check_mark: | N/A | | | `Name` | `string` | :heavy_check_mark: | N/A | | | `Slug` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.PresetStatus](../../models/components/presetstatus.mdx) | :heavy_check_mark: | The status of a preset. | active | +| `Status` | [components.PresetStatus](../../models/components/presetstatus) | :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` | [*components.PresetDesignatedVersion](../../models/components/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 +| `DesignatedVersion` | [*components.PresetDesignatedVersion](../../models/components/presetdesignatedversion) | :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 diff --git a/docs/models/components/preview20250311websearchservertool.mdx b/docs/models/components/preview20250311websearchservertool.mdx index ffc7980c..99f2c920 100644 --- a/docs/models/components/preview20250311websearchservertool.mdx +++ b/docs/models/components/preview20250311websearchservertool.mdx @@ -9,10 +9,10 @@ Web search preview tool configuration (2025-03-11 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/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` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum) | :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` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | | `MaxResults` | `*int64` | :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` | `*int64` | :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 | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.Preview20250311WebSearchServerToolType](../../models/components/preview20250311websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `Type` | [components.Preview20250311WebSearchServerToolType](../../models/components/preview20250311websearchservertooltype) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/previewwebsearchservertool.mdx b/docs/models/components/previewwebsearchservertool.mdx index e6a13f82..ee616123 100644 --- a/docs/models/components/previewwebsearchservertool.mdx +++ b/docs/models/components/previewwebsearchservertool.mdx @@ -9,10 +9,10 @@ Web search preview tool configuration | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/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` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum) | :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` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | | `MaxResults` | `*int64` | :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` | `*int64` | :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 | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.PreviewWebSearchServerToolType](../../models/components/previewwebsearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation.mdx)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `Type` | [components.PreviewWebSearchServerToolType](../../models/components/previewwebsearchservertooltype) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.PreviewWebSearchUserLocation](../../models/components/previewwebsearchuserlocation)] | :heavy_minus_sign: | N/A | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/previewwebsearchuserlocation.mdx b/docs/models/components/previewwebsearchuserlocation.mdx index e0ffc5a4..d9da324d 100644 --- a/docs/models/components/previewwebsearchuserlocation.mdx +++ b/docs/models/components/previewwebsearchuserlocation.mdx @@ -10,4 +10,4 @@ title: "PreviewWebSearchUserLocation" | `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.PreviewWebSearchUserLocationType](../../models/components/previewwebsearchuserlocationtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.PreviewWebSearchUserLocationType](../../models/components/previewwebsearchuserlocationtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/pricing.mdx b/docs/models/components/pricing.mdx index 9f14372a..a37d41f8 100644 --- a/docs/models/components/pricing.mdx +++ b/docs/models/components/pricing.mdx @@ -18,7 +18,7 @@ title: "Pricing" | `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` | [][components.PricingOverride](../../models/components/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. | +| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride) | :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 diff --git a/docs/models/components/promptcachebreakpoint.mdx b/docs/models/components/promptcachebreakpoint.mdx index 0c7f5e03..4e254048 100644 --- a/docs/models/components/promptcachebreakpoint.mdx +++ b/docs/models/components/promptcachebreakpoint.mdx @@ -9,4 +9,4 @@ Marks an explicit prompt-cache boundary on this content block (OpenAI-style). Ev | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Mode` | [components.PromptCacheBreakpointMode](../../models/components/promptcachebreakpointmode.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Mode` | [components.PromptCacheBreakpointMode](../../models/components/promptcachebreakpointmode) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/promptcacheoptions.mdx b/docs/models/components/promptcacheoptions.mdx index 6a231601..3e2815b4 100644 --- a/docs/models/components/promptcacheoptions.mdx +++ b/docs/models/components/promptcacheoptions.mdx @@ -9,5 +9,5 @@ Request-level prompt-cache controls. `mode: "explicit"` disables OpenAI-managed | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `Mode` | [components.PromptCacheOptionsMode](../../models/components/promptcacheoptionsmode.mdx) | :heavy_check_mark: | N/A | +| `Mode` | [components.PromptCacheOptionsMode](../../models/components/promptcacheoptionsmode) | :heavy_check_mark: | N/A | | `TTL` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/providerpreferences.mdx b/docs/models/components/providerpreferences.mdx index 41b4d85f..beeb9364 100644 --- a/docs/models/components/providerpreferences.mdx +++ b/docs/models/components/providerpreferences.mdx @@ -10,15 +10,15 @@ When multiple model providers are available, optionally indicate your routing pr | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AllowFallbacks` | optionalnullable.OptionalNullable[`bool`] | :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` | optionalnullable.OptionalNullable[[components.DataCollection](../../models/components/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 | +| `DataCollection` | optionalnullable.OptionalNullable[[components.DataCollection](../../models/components/datacollection)] | :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` | optionalnullable.OptionalNullable[`bool`] | :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` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesIgnore](../../models/components/providerpreferencesignore.mdx)] | :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` | [*components.MaxPrice](../../models/components/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` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOnly](../../models/components/providerpreferencesonly.mdx)] | :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"
] | -| `Order` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOrder](../../models/components/providerpreferencesorder.mdx)] | :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` | optionalnullable.OptionalNullable[[components.PreferredMaxLatency](../../models/components/preferredmaxlatency.mdx)] | :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` | optionalnullable.OptionalNullable[[components.PreferredMinThroughput](../../models/components/preferredminthroughput.mdx)] | :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` | optionalnullable.OptionalNullable[[][components.Quantization](../../models/components/quantization.mdx)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | +| `Ignore` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesIgnore](../../models/components/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` | [*components.MaxPrice](../../models/components/maxprice) | :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` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOnly](../../models/components/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"
] | +| `Order` | optionalnullable.OptionalNullable[[][components.ProviderPreferencesOrder](../../models/components/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` | optionalnullable.OptionalNullable[[components.PreferredMaxLatency](../../models/components/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` | optionalnullable.OptionalNullable[[components.PreferredMinThroughput](../../models/components/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` | optionalnullable.OptionalNullable[[][components.Quantization](../../models/components/quantization)] | :heavy_minus_sign: | A list of quantization levels to filter the provider by. | | | `RequireParameters` | optionalnullable.OptionalNullable[`bool`] | :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` | optionalnullable.OptionalNullable[[components.ProviderPreferencesSort](../../models/components/providerpreferencessort.mdx)] | :heavy_minus_sign: | The sorting strategy to use for this request, if "order" is not specified. When set, no load balancing is performed. | price | +| `Sort` | optionalnullable.OptionalNullable[[components.ProviderPreferencesSort](../../models/components/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` | optionalnullable.OptionalNullable[`bool`] | :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 diff --git a/docs/models/components/providerresponse.mdx b/docs/models/components/providerresponse.mdx index ff273dd8..ec22322e 100644 --- a/docs/models/components/providerresponse.mdx +++ b/docs/models/components/providerresponse.mdx @@ -14,6 +14,6 @@ Details of a provider response for a generation attempt | `IsByok` | `*bool` | :heavy_minus_sign: | Whether the request used a bring-your-own-key | false | | `Latency` | `*float64` | :heavy_minus_sign: | Response latency in milliseconds | 1200 | | `ModelPermaslug` | `*string` | :heavy_minus_sign: | Canonical model slug | openai/gpt-4 | -| `ProviderName` | [*components.ProviderResponseProviderName](../../models/components/providerresponseprovidername.mdx) | :heavy_minus_sign: | Name of the provider | OpenAI | -| `RoutedServiceTier` | [*components.RoutedServiceTier](../../models/components/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 | +| `ProviderName` | [*components.ProviderResponseProviderName](../../models/components/providerresponseprovidername) | :heavy_minus_sign: | Name of the provider | OpenAI | +| `RoutedServiceTier` | [*components.RoutedServiceTier](../../models/components/routedservicetier) | :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` | `*int64` | :heavy_check_mark: | HTTP status code from the provider | 200 | \ No newline at end of file diff --git a/docs/models/components/providersortconfig.mdx b/docs/models/components/providersortconfig.mdx index aa7bef7f..c4131b9f 100644 --- a/docs/models/components/providersortconfig.mdx +++ b/docs/models/components/providersortconfig.mdx @@ -9,5 +9,5 @@ The provider sorting strategy (price, throughput, latency) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `By` | optionalnullable.OptionalNullable[[components.By](../../models/components/by.mdx)] | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | -| `Partition` | optionalnullable.OptionalNullable[[components.Partition](../../models/components/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` | optionalnullable.OptionalNullable[[components.By](../../models/components/by)] | :heavy_minus_sign: | The provider sorting strategy (price, throughput, latency) | price | +| `Partition` | optionalnullable.OptionalNullable[[components.Partition](../../models/components/partition)] | :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 diff --git a/docs/models/components/publicendpoint.mdx b/docs/models/components/publicendpoint.mdx index 3293a6bf..64f9e020 100644 --- a/docs/models/components/publicendpoint.mdx +++ b/docs/models/components/publicendpoint.mdx @@ -10,20 +10,20 @@ Information about a specific model endpoint | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ContextLength` | `int64` | :heavy_check_mark: | N/A | | -| `LatencyLast30m` | [*components.PercentileStats](../../models/components/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
} | +| `LatencyLast30m` | [*components.PercentileStats](../../models/components/percentilestats) | :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` | `*int64` | :heavy_check_mark: | N/A | | | `MaxPromptTokens` | `*int64` | :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 | | -| `Pricing` | [components.Pricing](../../models/components/pricing.mdx) | :heavy_check_mark: | N/A | | -| `ProviderName` | [components.ProviderName](../../models/components/providername.mdx) | :heavy_check_mark: | N/A | OpenAI | -| `Quantization` | [*components.Quantization](../../models/components/quantization.mdx) | :heavy_check_mark: | N/A | fp16 | -| `Status` | [*components.EndpointStatus](../../models/components/endpointstatus.mdx) | :heavy_minus_sign: | N/A | 0 | -| `SupportedParameters` | [][components.Parameter](../../models/components/parameter.mdx) | :heavy_check_mark: | N/A | | +| `Pricing` | [components.Pricing](../../models/components/pricing) | :heavy_check_mark: | N/A | | +| `ProviderName` | [components.ProviderName](../../models/components/providername) | :heavy_check_mark: | N/A | OpenAI | +| `Quantization` | [*components.Quantization](../../models/components/quantization) | :heavy_check_mark: | N/A | fp16 | +| `Status` | [*components.EndpointStatus](../../models/components/endpointstatus) | :heavy_minus_sign: | N/A | 0 | +| `SupportedParameters` | [][components.Parameter](../../models/components/parameter) | :heavy_check_mark: | N/A | | | `SupportsImplicitCaching` | `bool` | :heavy_check_mark: | N/A | | | `Tag` | `string` | :heavy_check_mark: | N/A | | -| `ThroughputLast30m` | [*components.PercentileStats](../../models/components/percentilestats.mdx) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | +| `ThroughputLast30m` | [*components.PercentileStats](../../models/components/percentilestats) | :heavy_check_mark: | N/A | \{
"p50": 25.5,
"p75": 35.2,
"p90": 48.7,
"p99": 85.3
} | | `UptimeLast1d` | `*float64` | :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` | `*float64` | :heavy_check_mark: | N/A | | | `UptimeLast5m` | `*float64` | :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 diff --git a/docs/models/components/publicpricing.mdx b/docs/models/components/publicpricing.mdx index 68789233..b514f5e3 100644 --- a/docs/models/components/publicpricing.mdx +++ b/docs/models/components/publicpricing.mdx @@ -21,7 +21,7 @@ Pricing information for the model | `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` | [][components.PricingOverride](../../models/components/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. | +| `Overrides` | [][components.PricingOverride](../../models/components/pricingoverride) | :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 diff --git a/docs/models/components/rangecapability.mdx b/docs/models/components/rangecapability.mdx index 14bda343..e1395026 100644 --- a/docs/models/components/rangecapability.mdx +++ b/docs/models/components/rangecapability.mdx @@ -11,4 +11,4 @@ A parameter that accepts any value within an inclusive numeric range. | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `Max` | `float64` | :heavy_check_mark: | N/A | | `Min` | `float64` | :heavy_check_mark: | N/A | -| `Type` | [components.RangeCapabilityType](../../models/components/rangecapabilitytype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.RangeCapabilityType](../../models/components/rangecapabilitytype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/rankingoptions.mdx b/docs/models/components/rankingoptions.mdx index 0ae1d447..72ba1213 100644 --- a/docs/models/components/rankingoptions.mdx +++ b/docs/models/components/rankingoptions.mdx @@ -6,5 +6,5 @@ title: "RankingOptions" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Ranker` | [*components.Ranker](../../models/components/ranker.mdx) | :heavy_minus_sign: | N/A | +| `Ranker` | [*components.Ranker](../../models/components/ranker) | :heavy_minus_sign: | N/A | | `ScoreThreshold` | `*float64` | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/rankingsdailymeta.mdx b/docs/models/components/rankingsdailymeta.mdx index aeefdb44..9e450541 100644 --- a/docs/models/components/rankingsdailymeta.mdx +++ b/docs/models/components/rankingsdailymeta.mdx @@ -9,4 +9,4 @@ title: "RankingsDailyMeta" | `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:00Z | | `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` | [components.RankingsDailyMetaVersion](../../models/components/rankingsdailymetaversion.mdx) | :heavy_check_mark: | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file +| `Version` | [components.RankingsDailyMetaVersion](../../models/components/rankingsdailymetaversion) | :heavy_check_mark: | Dataset version. Field names and grain are stable for the life of `v1`. | | \ No newline at end of file diff --git a/docs/models/components/rankingsdailyresponse.mdx b/docs/models/components/rankingsdailyresponse.mdx index 8b6f945c..a7537627 100644 --- a/docs/models/components/rankingsdailyresponse.mdx +++ b/docs/models/components/rankingsdailyresponse.mdx @@ -6,5 +6,5 @@ title: "RankingsDailyResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.RankingsDailyItem](../../models/components/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` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta.mdx) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file +| `Data` | [][components.RankingsDailyItem](../../models/components/rankingsdailyitem) | :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` | [components.RankingsDailyMeta](../../models/components/rankingsdailymeta) | :heavy_check_mark: | N/A | \{
"as_of": "2026-05-12T02:00:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
} | \ No newline at end of file diff --git a/docs/models/components/reasoningconfig.mdx b/docs/models/components/reasoningconfig.mdx index be18c63d..548fb4ec 100644 --- a/docs/models/components/reasoningconfig.mdx +++ b/docs/models/components/reasoningconfig.mdx @@ -6,9 +6,9 @@ title: "ReasoningConfig" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/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` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort.mdx)] | :heavy_minus_sign: | N/A | medium | -| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/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` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity.mdx)] | :heavy_minus_sign: | N/A | auto | +| `Context` | optionalnullable.OptionalNullable[[components.ReasoningContext](../../models/components/reasoningcontext)] | :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` | optionalnullable.OptionalNullable[[components.ReasoningEffort](../../models/components/reasoningeffort)] | :heavy_minus_sign: | N/A | medium | +| `Mode` | optionalnullable.OptionalNullable[[components.ReasoningMode](../../models/components/reasoningmode)] | :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` | optionalnullable.OptionalNullable[[components.ReasoningSummaryVerbosity](../../models/components/reasoningsummaryverbosity)] | :heavy_minus_sign: | N/A | auto | | `Enabled` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | | `MaxTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdeltaevent.mdx b/docs/models/components/reasoningdeltaevent.mdx index 6d30d890..95bde2bd 100644 --- a/docs/models/components/reasoningdeltaevent.mdx +++ b/docs/models/components/reasoningdeltaevent.mdx @@ -14,4 +14,4 @@ Event emitted when reasoning text delta is streamed | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningDeltaEventType](../../models/components/reasoningdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ReasoningDeltaEventType](../../models/components/reasoningdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailencrypted.mdx b/docs/models/components/reasoningdetailencrypted.mdx index 29b6a2c1..c185e8e5 100644 --- a/docs/models/components/reasoningdetailencrypted.mdx +++ b/docs/models/components/reasoningdetailencrypted.mdx @@ -10,7 +10,7 @@ Reasoning detail encrypted schema | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `Data` | `string` | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat)] | :heavy_minus_sign: | N/A | unknown | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `Index` | `*int64` | :heavy_minus_sign: | N/A | | -| `Type` | [components.ReasoningDetailEncryptedType](../../models/components/reasoningdetailencryptedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.ReasoningDetailEncryptedType](../../models/components/reasoningdetailencryptedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailservertoolcall.mdx b/docs/models/components/reasoningdetailservertoolcall.mdx index fbfa24ee..44ff08d4 100644 --- a/docs/models/components/reasoningdetailservertoolcall.mdx +++ b/docs/models/components/reasoningdetailservertoolcall.mdx @@ -10,10 +10,10 @@ Record of an OpenRouter server-tool invocation (e.g. openrouter:fusion), carried | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `Arguments` | `string` | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat)] | :heavy_minus_sign: | N/A | unknown | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `Index` | `*int64` | :heavy_minus_sign: | N/A | | | `Result` | `string` | :heavy_check_mark: | N/A | | | `ToolCallID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `ToolName` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningDetailServerToolCallType](../../models/components/reasoningdetailservertoolcalltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.ReasoningDetailServerToolCallType](../../models/components/reasoningdetailservertoolcalltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailsummary.mdx b/docs/models/components/reasoningdetailsummary.mdx index 27d2e923..a6a3dea8 100644 --- a/docs/models/components/reasoningdetailsummary.mdx +++ b/docs/models/components/reasoningdetailsummary.mdx @@ -9,8 +9,8 @@ Reasoning detail summary schema | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat)] | :heavy_minus_sign: | N/A | unknown | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `Index` | `*int64` | :heavy_minus_sign: | N/A | | | `Summary` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningDetailSummaryType](../../models/components/reasoningdetailsummarytype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.ReasoningDetailSummaryType](../../models/components/reasoningdetailsummarytype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdetailtext.mdx b/docs/models/components/reasoningdetailtext.mdx index 2a8540c9..07ad8d35 100644 --- a/docs/models/components/reasoningdetailtext.mdx +++ b/docs/models/components/reasoningdetailtext.mdx @@ -9,9 +9,9 @@ Reasoning detail text schema | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat)] | :heavy_minus_sign: | N/A | unknown | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `Index` | `*int64` | :heavy_minus_sign: | N/A | | | `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `Text` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Type` | [components.ReasoningDetailTextType](../../models/components/reasoningdetailtexttype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.ReasoningDetailTextType](../../models/components/reasoningdetailtexttype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningdoneevent.mdx b/docs/models/components/reasoningdoneevent.mdx index 154d52c5..58722a11 100644 --- a/docs/models/components/reasoningdoneevent.mdx +++ b/docs/models/components/reasoningdoneevent.mdx @@ -14,4 +14,4 @@ Event emitted when reasoning text streaming is complete | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningDoneEventType](../../models/components/reasoningdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ReasoningDoneEventType](../../models/components/reasoningdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningitem.mdx b/docs/models/components/reasoningitem.mdx index 436dee9e..9ffa6742 100644 --- a/docs/models/components/reasoningitem.mdx +++ b/docs/models/components/reasoningitem.mdx @@ -9,11 +9,11 @@ Reasoning output item with signature and format extensions | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent.mdx)] | :heavy_minus_sign: | N/A | | +| `Content` | optionalnullable.OptionalNullable[[][components.ReasoningTextContent](../../models/components/reasoningtextcontent)] | :heavy_minus_sign: | N/A | | | `EncryptedContent` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `ID` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [*components.ReasoningItemStatusUnion](../../models/components/reasoningitemstatusunion.mdx) | :heavy_minus_sign: | N/A | | -| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningItemType](../../models/components/reasoningitemtype.mdx) | :heavy_check_mark: | N/A | | -| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat.mdx)] | :heavy_minus_sign: | N/A | unknown | +| `Status` | [*components.ReasoningItemStatusUnion](../../models/components/reasoningitemstatusunion) | :heavy_minus_sign: | N/A | | +| `Summary` | [][components.ReasoningSummaryText](../../models/components/reasoningsummarytext) | :heavy_check_mark: | N/A | | +| `Type` | [components.ReasoningItemType](../../models/components/reasoningitemtype) | :heavy_check_mark: | N/A | | +| `Format` | optionalnullable.OptionalNullable[[components.ReasoningFormat](../../models/components/reasoningformat)] | :heavy_minus_sign: | N/A | unknown | | `Signature` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarypartaddedevent.mdx b/docs/models/components/reasoningsummarypartaddedevent.mdx index 6b89dae4..33fae4ab 100644 --- a/docs/models/components/reasoningsummarypartaddedevent.mdx +++ b/docs/models/components/reasoningsummarypartaddedevent.mdx @@ -11,7 +11,7 @@ Event emitted when a reasoning summary part is added | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `ItemID` | `string` | :heavy_check_mark: | N/A | | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | | `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningSummaryPartAddedEventType](../../models/components/reasoningsummarypartaddedeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.ReasoningSummaryPartAddedEventType](../../models/components/reasoningsummarypartaddedeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarypartdoneevent.mdx b/docs/models/components/reasoningsummarypartdoneevent.mdx index ef0f09aa..a3698cbf 100644 --- a/docs/models/components/reasoningsummarypartdoneevent.mdx +++ b/docs/models/components/reasoningsummarypartdoneevent.mdx @@ -11,7 +11,7 @@ Event emitted when a reasoning summary part is complete | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `ItemID` | `string` | :heavy_check_mark: | N/A | | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext.mdx) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | +| `Part` | [components.ReasoningSummaryText](../../models/components/reasoningsummarytext) | :heavy_check_mark: | N/A | \{
"text": "Analyzed the problem using first principles",
"type": "summary_text"
} | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | | `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.ReasoningSummaryPartDoneEventType](../../models/components/reasoningsummarypartdoneeventtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.ReasoningSummaryPartDoneEventType](../../models/components/reasoningsummarypartdoneeventtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarytext.mdx b/docs/models/components/reasoningsummarytext.mdx index 20917474..d16abd11 100644 --- a/docs/models/components/reasoningsummarytext.mdx +++ b/docs/models/components/reasoningsummarytext.mdx @@ -7,4 +7,4 @@ title: "ReasoningSummaryText" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningSummaryTextType](../../models/components/reasoningsummarytexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ReasoningSummaryTextType](../../models/components/reasoningsummarytexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarytextdeltaevent.mdx b/docs/models/components/reasoningsummarytextdeltaevent.mdx index f79a9e10..e7e87921 100644 --- a/docs/models/components/reasoningsummarytextdeltaevent.mdx +++ b/docs/models/components/reasoningsummarytextdeltaevent.mdx @@ -14,4 +14,4 @@ Event emitted when reasoning summary text delta is streamed | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningSummaryTextDeltaEventType](../../models/components/reasoningsummarytextdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ReasoningSummaryTextDeltaEventType](../../models/components/reasoningsummarytextdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningsummarytextdoneevent.mdx b/docs/models/components/reasoningsummarytextdoneevent.mdx index 9692b4b6..ef05240b 100644 --- a/docs/models/components/reasoningsummarytextdoneevent.mdx +++ b/docs/models/components/reasoningsummarytextdoneevent.mdx @@ -14,4 +14,4 @@ Event emitted when reasoning summary text streaming is complete | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | `SummaryIndex` | `int64` | :heavy_check_mark: | N/A | | `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningSummaryTextDoneEventType](../../models/components/reasoningsummarytextdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ReasoningSummaryTextDoneEventType](../../models/components/reasoningsummarytextdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/reasoningtextcontent.mdx b/docs/models/components/reasoningtextcontent.mdx index cce8e4aa..d6bb00ee 100644 --- a/docs/models/components/reasoningtextcontent.mdx +++ b/docs/models/components/reasoningtextcontent.mdx @@ -7,4 +7,4 @@ title: "ReasoningTextContent" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ReasoningTextContentType](../../models/components/reasoningtextcontenttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ReasoningTextContentType](../../models/components/reasoningtextcontenttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/refusaldeltaevent.mdx b/docs/models/components/refusaldeltaevent.mdx index 1a2213c7..5cbf4821 100644 --- a/docs/models/components/refusaldeltaevent.mdx +++ b/docs/models/components/refusaldeltaevent.mdx @@ -14,4 +14,4 @@ Event emitted when a refusal delta is streamed | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.RefusalDeltaEventType](../../models/components/refusaldeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.RefusalDeltaEventType](../../models/components/refusaldeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/refusaldoneevent.mdx b/docs/models/components/refusaldoneevent.mdx index d4eaeff0..fc65bdb8 100644 --- a/docs/models/components/refusaldoneevent.mdx +++ b/docs/models/components/refusaldoneevent.mdx @@ -14,4 +14,4 @@ Event emitted when refusal streaming is complete | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `Refusal` | `string` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.RefusalDoneEventType](../../models/components/refusaldoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.RefusalDoneEventType](../../models/components/refusaldoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/requireapproval.mdx b/docs/models/components/requireapproval.mdx index da9605a2..d245f7ef 100644 --- a/docs/models/components/requireapproval.mdx +++ b/docs/models/components/requireapproval.mdx @@ -6,5 +6,5 @@ title: "RequireApproval" | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Always` | [*components.Always](../../models/components/always.mdx) | :heavy_minus_sign: | N/A | -| `Never` | [*components.Never](../../models/components/never.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Always` | [*components.Always](../../models/components/always) | :heavy_minus_sign: | N/A | +| `Never` | [*components.Never](../../models/components/never) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/responsehealingplugin.mdx b/docs/models/components/responsehealingplugin.mdx index 6ca7b323..919a25c2 100644 --- a/docs/models/components/responsehealingplugin.mdx +++ b/docs/models/components/responsehealingplugin.mdx @@ -7,4 +7,4 @@ title: "ResponseHealingPlugin" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the response-healing plugin for this request. Defaults to true. | -| `ID` | [components.ResponseHealingPluginID](../../models/components/responsehealingpluginid.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ID` | [components.ResponseHealingPluginID](../../models/components/responsehealingpluginid) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/responseoutputtext.mdx b/docs/models/components/responseoutputtext.mdx index 41a039c7..ccf71edd 100644 --- a/docs/models/components/responseoutputtext.mdx +++ b/docs/models/components/responseoutputtext.mdx @@ -6,7 +6,7 @@ title: "ResponseOutputText" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Annotations` | [][components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation.mdx) | :heavy_minus_sign: | N/A | -| `Logprobs` | [][components.Logprob](../../models/components/logprob.mdx) | :heavy_minus_sign: | N/A | +| `Annotations` | [][components.OpenAIResponsesAnnotation](../../models/components/openairesponsesannotation) | :heavy_minus_sign: | N/A | +| `Logprobs` | [][components.Logprob](../../models/components/logprob) | :heavy_minus_sign: | N/A | | `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.ResponseOutputTextType](../../models/components/responseoutputtexttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ResponseOutputTextType](../../models/components/responseoutputtexttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/responseserrorfield.mdx b/docs/models/components/responseserrorfield.mdx index c9169a1a..fea0b4d1 100644 --- a/docs/models/components/responseserrorfield.mdx +++ b/docs/models/components/responseserrorfield.mdx @@ -9,5 +9,5 @@ Error information returned from the API | Field | Type | Required | Description | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `Code` | [components.Code](../../models/components/code.mdx) | :heavy_check_mark: | N/A | +| `Code` | [components.Code](../../models/components/code) | :heavy_check_mark: | N/A | | `Message` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/responsesrequest.mdx b/docs/models/components/responsesrequest.mdx index fda03295..87f961d3 100644 --- a/docs/models/components/responsesrequest.mdx +++ b/docs/models/components/responsesrequest.mdx @@ -10,41 +10,41 @@ Request schema for Responses endpoint | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Background` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions.mdx) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [*components.ChatDebugOptions](../../models/components/chatdebugoptions) | :heavy_minus_sign: | Debug options for inspecting request transformations (streaming only) | \{
"echo_upstream_body": true
} | | `FrequencyPenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig.mdx) | :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` | optionalnullable.OptionalNullable[[][components.ResponseIncludesEnum](../../models/components/responseincludesenum.mdx)] | :heavy_minus_sign: | N/A | | -| `Input` | [*components.InputsUnion](../../models/components/inputsunion.mdx) | :heavy_minus_sign: | Input for a response request - can be a string or array of items | [
\{
"content": "What is the weather today?",
"role": "user"
}
] | +| `ImageConfig` | map[string][components.ImageConfig](../../models/components/imageconfig) | :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` | optionalnullable.OptionalNullable[[][components.ResponseIncludesEnum](../../models/components/responseincludesenum)] | :heavy_minus_sign: | N/A | | +| `Input` | [*components.InputsUnion](../../models/components/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` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `MaxOutputTokens` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | | `MaxToolCalls` | optionalnullable.OptionalNullable[`int64`] | :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` | optionalnullable.OptionalNullable[map[string]`string`] | :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` | [][components.OutputModalityEnum](../../models/components/outputmodalityenum.mdx) | :heavy_minus_sign: | Output modalities for the response. Supported values are "text" and "image". | [
"text",
"image"
] | +| `Modalities` | [][components.OutputModalityEnum](../../models/components/outputmodalityenum) | :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` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | | -| `Plugins` | [][components.ResponsesRequestPlugin](../../models/components/responsesrequestplugin.mdx) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | +| `Plugins` | [][components.ResponsesRequestPlugin](../../models/components/responsesrequestplugin) | :heavy_minus_sign: | Plugins you want to enable for this request, including their settings. | | | `PresencePenalty` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | | `PreviousResponseID` | `any` | :heavy_minus_sign: | Not supported. The Responses API is stateless: 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` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate.mdx)] | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | +| `Prompt` | optionalnullable.OptionalNullable[[components.StoredPromptTemplate](../../models/components/storedprompttemplate)] | :heavy_minus_sign: | N/A | \{
"id": "prompt-abc123",
"variables": \{
"name": "John"
}
} | | `PromptCacheKey` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/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` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | -| `Reasoning` | optionalnullable.OptionalNullable[[components.ReasoningConfig](../../models/components/reasoningconfig.mdx)] | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | +| `PromptCacheOptions` | optionalnullable.OptionalNullable[[components.PromptCacheOptions](../../models/components/promptcacheoptions)] | :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` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences)] | :heavy_minus_sign: | When multiple model providers are available, optionally indicate your routing preference. | \{
"allow_fallbacks": true
} | +| `Reasoning` | optionalnullable.OptionalNullable[[components.ReasoningConfig](../../models/components/reasoningconfig)] | :heavy_minus_sign: | Configuration for reasoning mode in the response | \{
"enabled": true,
"summary": "auto"
} | | `SafetyIdentifier` | optionalnullable.OptionalNullable[`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` | optionalnullable.OptionalNullable[[components.ResponsesRequestServiceTier](../../models/components/responsesrequestservicetier.mdx)] | :heavy_minus_sign: | N/A | | +| `ServiceTier` | optionalnullable.OptionalNullable[[components.ResponsesRequestServiceTier](../../models/components/responsesrequestservicetier)] | :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. | | -| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/stopservertoolswhencondition.mdx) | :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"
}
] | +| `StopServerToolsWhen` | [][components.StopServerToolsWhenCondition](../../models/components/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` | `*bool` | :heavy_minus_sign: | N/A | | | `Stream` | `*bool` | :heavy_minus_sign: | N/A | | | `Temperature` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig.mdx) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | -| `ToolChoice` | [*components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion.mdx) | :heavy_minus_sign: | N/A | auto | -| `Tools` | [][components.ResponsesRequestToolUnion](../../models/components/responsesrequesttoolunion.mdx) | :heavy_minus_sign: | N/A | | +| `Text` | [*components.TextExtendedConfig](../../models/components/textextendedconfig) | :heavy_minus_sign: | Text output configuration including format and verbosity | \{
"format": \{
"type": "text"
}
} | +| `ToolChoice` | [*components.OpenAIResponsesToolChoiceUnion](../../models/components/openairesponsestoolchoiceunion) | :heavy_minus_sign: | N/A | auto | +| `Tools` | [][components.ResponsesRequestToolUnion](../../models/components/responsesrequesttoolunion) | :heavy_minus_sign: | N/A | | | `TopK` | `*int64` | :heavy_minus_sign: | N/A | | | `TopLogprobs` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | | `TopP` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | N/A | | -| `Trace` | [*components.TraceConfig](../../models/components/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` | optionalnullable.OptionalNullable[[components.OpenAIResponsesTruncation](../../models/components/openairesponsestruncation.mdx)] | :heavy_minus_sign: | N/A | auto | +| `Trace` | [*components.TraceConfig](../../models/components/traceconfig) | :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` | optionalnullable.OptionalNullable[[components.OpenAIResponsesTruncation](../../models/components/openairesponsestruncation)] | :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 diff --git a/docs/models/components/responsesrequesttoolfunction.mdx b/docs/models/components/responsesrequesttoolfunction.mdx index 4d316cae..86d5f978 100644 --- a/docs/models/components/responsesrequesttoolfunction.mdx +++ b/docs/models/components/responsesrequesttoolfunction.mdx @@ -13,4 +13,4 @@ Function tool definition | `Name` | `string` | :heavy_check_mark: | N/A | | `Parameters` | map[string]`any` | :heavy_check_mark: | N/A | | `Strict` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | N/A | -| `Type` | [components.ResponsesRequestType](../../models/components/responsesrequesttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ResponsesRequestType](../../models/components/responsesrequesttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/responsesstreamingresponse.mdx b/docs/models/components/responsesstreamingresponse.mdx index 19b424ff..c328506b 100644 --- a/docs/models/components/responsesstreamingresponse.mdx +++ b/docs/models/components/responsesstreamingresponse.mdx @@ -6,4 +6,4 @@ title: "ResponsesStreamingResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.StreamEvents](../../models/components/streamevents.mdx) | :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` | [components.StreamEvents](../../models/components/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 diff --git a/docs/models/components/rule.mdx b/docs/models/components/rule.mdx index 5f0969eb..9ccf6208 100644 --- a/docs/models/components/rule.mdx +++ b/docs/models/components/rule.mdx @@ -6,6 +6,6 @@ title: "Rule" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `Field` | [components.Field](../../models/components/field.mdx) | :heavy_check_mark: | N/A | -| `Operator` | [components.Operator](../../models/components/operator.mdx) | :heavy_check_mark: | N/A | -| `Value` | [*components.ObservabilityFilterRuleGroupValue](../../models/components/observabilityfilterrulegroupvalue.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Field` | [components.Field](../../models/components/field) | :heavy_check_mark: | N/A | +| `Operator` | [components.Operator](../../models/components/operator) | :heavy_check_mark: | N/A | +| `Value` | [*components.ObservabilityFilterRuleGroupValue](../../models/components/observabilityfilterrulegroupvalue) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/searchmodelsservertoolopenrouter.mdx b/docs/models/components/searchmodelsservertoolopenrouter.mdx index 29bb89eb..ca3b2d82 100644 --- a/docs/models/components/searchmodelsservertoolopenrouter.mdx +++ b/docs/models/components/searchmodelsservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches and filters AI models available on Ope | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | -| `Type` | [components.SearchModelsServerToolOpenRouterType](../../models/components/searchmodelsservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.SearchModelsServerToolConfig](../../models/components/searchmodelsservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:experimental__search_models server tool | \{
"max_results": 5
} | +| `Type` | [components.SearchModelsServerToolOpenRouterType](../../models/components/searchmodelsservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/shellcallitem.mdx b/docs/models/components/shellcallitem.mdx index ee26a731..11194d69 100644 --- a/docs/models/components/shellcallitem.mdx +++ b/docs/models/components/shellcallitem.mdx @@ -9,9 +9,9 @@ A shell command execution call (newer variant) | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `Action` | [components.ShellCallItemAction](../../models/components/shellcallitemaction.mdx) | :heavy_check_mark: | N/A | | +| `Action` | [components.ShellCallItemAction](../../models/components/shellcallitemaction) | :heavy_check_mark: | N/A | | | `CallID` | `string` | :heavy_check_mark: | N/A | | | `Environment` | `any` | :heavy_minus_sign: | N/A | | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.ShellCallItemType](../../models/components/shellcallitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.ShellCallItemType](../../models/components/shellcallitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/shellcalloutputitem.mdx b/docs/models/components/shellcalloutputitem.mdx index 60e72294..8486cd38 100644 --- a/docs/models/components/shellcalloutputitem.mdx +++ b/docs/models/components/shellcalloutputitem.mdx @@ -12,6 +12,6 @@ Output from a shell command execution (newer variant) | `CallID` | `string` | :heavy_check_mark: | N/A | | | `ID` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | | `MaxOutputLength` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Output` | [][components.ShellCallOutputItemOutput](../../models/components/shellcalloutputitemoutput.mdx) | :heavy_check_mark: | N/A | | -| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus.mdx)] | :heavy_minus_sign: | N/A | completed | -| `Type` | [components.ShellCallOutputItemType](../../models/components/shellcalloutputitemtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Output` | [][components.ShellCallOutputItemOutput](../../models/components/shellcalloutputitemoutput) | :heavy_check_mark: | N/A | | +| `Status` | optionalnullable.OptionalNullable[[components.ToolCallStatus](../../models/components/toolcallstatus)] | :heavy_minus_sign: | N/A | completed | +| `Type` | [components.ShellCallOutputItemType](../../models/components/shellcalloutputitemtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/shellservertool.mdx b/docs/models/components/shellservertool.mdx index 95163852..215b07e8 100644 --- a/docs/models/components/shellservertool.mdx +++ b/docs/models/components/shellservertool.mdx @@ -9,4 +9,4 @@ Shell tool configuration | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.ShellServerToolType](../../models/components/shellservertooltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ShellServerToolType](../../models/components/shellservertooltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/shellservertoolconfig.mdx b/docs/models/components/shellservertoolconfig.mdx index fc7eea84..145a1e9a 100644 --- a/docs/models/components/shellservertoolconfig.mdx +++ b/docs/models/components/shellservertoolconfig.mdx @@ -9,6 +9,6 @@ Configuration for the openrouter:shell server tool | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.ShellServerToolEngine](../../models/components/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` | [*components.ShellServerToolEnvironment](../../models/components/shellservertoolenvironment.mdx) | :heavy_minus_sign: | Server-side execution environment for the shell tool. Only container-backed environments are supported; "local" shells are not. | \{
"type": "container_auto"
} | +| `Engine` | [*components.ShellServerToolEngine](../../models/components/shellservertoolengine) | :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` | [*components.ShellServerToolEnvironment](../../models/components/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"
} | | `SleepAfterSeconds` | `*int64` | :heavy_minus_sign: | How long (in seconds) the container stays warm after its last command before sleeping, freeing its capacity slot. Idle-based: each command renews the timer. Defaults to 900 (15 minutes); capped at 2592000 (30 days). | 900 | \ No newline at end of file diff --git a/docs/models/components/shellservertoolopenrouter.mdx b/docs/models/components/shellservertoolopenrouter.mdx index 33674ea7..759b7a07 100644 --- a/docs/models/components/shellservertoolopenrouter.mdx +++ b/docs/models/components/shellservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: runs shell commands server-side in a sandboxed | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.ShellServerToolConfig](../../models/components/shellservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | -| `Type` | [components.ShellServerToolOpenRouterType](../../models/components/shellservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.ShellServerToolConfig](../../models/components/shellservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:shell server tool | \{
"engine": "openrouter",
"environment": \{
"type": "container_auto"
}
} | +| `Type` | [components.ShellServerToolOpenRouterType](../../models/components/shellservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/sourcecontent.mdx b/docs/models/components/sourcecontent.mdx index d471d960..fcc7e197 100644 --- a/docs/models/components/sourcecontent.mdx +++ b/docs/models/components/sourcecontent.mdx @@ -6,5 +6,5 @@ title: "SourceContent" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Content` | [components.AnthropicDocumentBlockParamContent2](../../models/components/anthropicdocumentblockparamcontent2.mdx) | :heavy_check_mark: | N/A | -| `Type` | [components.SourceType](../../models/components/sourcetype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [components.AnthropicDocumentBlockParamContent2](../../models/components/anthropicdocumentblockparamcontent2) | :heavy_check_mark: | N/A | +| `Type` | [components.SourceType](../../models/components/sourcetype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/speechrequest.mdx b/docs/models/components/speechrequest.mdx index f0492e91..7f1f251c 100644 --- a/docs/models/components/speechrequest.mdx +++ b/docs/models/components/speechrequest.mdx @@ -11,7 +11,7 @@ Text-to-speech request input | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | `Input` | `string` | :heavy_check_mark: | Text to synthesize | Hello world | | `Model` | `string` | :heavy_check_mark: | TTS model identifier | mistralai/voxtral-mini-tts-2603 | -| `Provider` | [*components.SpeechRequestProvider](../../models/components/speechrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `ResponseFormat` | [*components.SpeechRequestResponseFormat](../../models/components/speechrequestresponseformat.mdx) | :heavy_minus_sign: | Audio output format | pcm | +| `Provider` | [*components.SpeechRequestProvider](../../models/components/speechrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | +| `ResponseFormat` | [*components.SpeechRequestResponseFormat](../../models/components/speechrequestresponseformat) | :heavy_minus_sign: | Audio output format | pcm | | `Speed` | `*float64` | :heavy_minus_sign: | Playback speed multiplier. Only used by models that support it (e.g. OpenAI TTS). Ignored by other providers. | 1 | | `Voice` | `string` | :heavy_check_mark: | Voice identifier (provider-specific). | en_paul_neutral | \ No newline at end of file diff --git a/docs/models/components/speechrequestprovider.mdx b/docs/models/components/speechrequestprovider.mdx index 09a7d13c..b4e407ae 100644 --- a/docs/models/components/speechrequestprovider.mdx +++ b/docs/models/components/speechrequestprovider.mdx @@ -9,4 +9,4 @@ Provider-specific passthrough configuration | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Options` | [*components.ProviderOptions](../../models/components/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
}
} | \ No newline at end of file +| `Options` | [*components.ProviderOptions](../../models/components/provideroptions) | :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
}
} | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenfinishreasonis.mdx b/docs/models/components/stopservertoolswhenfinishreasonis.mdx index 303e057b..d098ada8 100644 --- a/docs/models/components/stopservertoolswhenfinishreasonis.mdx +++ b/docs/models/components/stopservertoolswhenfinishreasonis.mdx @@ -10,4 +10,4 @@ Stop when the upstream model emits this finish reason (e.g. `length`). | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `Reason` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenFinishReasonIsType](../../models/components/stopservertoolswhenfinishreasonistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.StopServerToolsWhenFinishReasonIsType](../../models/components/stopservertoolswhenfinishreasonistype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenhastoolcall.mdx b/docs/models/components/stopservertoolswhenhastoolcall.mdx index 54c1d409..a2477e98 100644 --- a/docs/models/components/stopservertoolswhenhastoolcall.mdx +++ b/docs/models/components/stopservertoolswhenhastoolcall.mdx @@ -10,4 +10,4 @@ Stop after a tool with this name has been called. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `ToolName` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenHasToolCallType](../../models/components/stopservertoolswhenhastoolcalltype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.StopServerToolsWhenHasToolCallType](../../models/components/stopservertoolswhenhastoolcalltype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenmaxcost.mdx b/docs/models/components/stopservertoolswhenmaxcost.mdx index addcbca5..c7e558a9 100644 --- a/docs/models/components/stopservertoolswhenmaxcost.mdx +++ b/docs/models/components/stopservertoolswhenmaxcost.mdx @@ -10,4 +10,4 @@ Stop once cumulative cost across the loop exceeds this dollar threshold. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `MaxCostInDollars` | `float64` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenMaxCostType](../../models/components/stopservertoolswhenmaxcosttype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.StopServerToolsWhenMaxCostType](../../models/components/stopservertoolswhenmaxcosttype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenmaxtokensused.mdx b/docs/models/components/stopservertoolswhenmaxtokensused.mdx index c229dcbe..7900052d 100644 --- a/docs/models/components/stopservertoolswhenmaxtokensused.mdx +++ b/docs/models/components/stopservertoolswhenmaxtokensused.mdx @@ -10,4 +10,4 @@ Stop once cumulative token usage across the loop exceeds this threshold. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | `MaxTokens` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenMaxTokensUsedType](../../models/components/stopservertoolswhenmaxtokensusedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.StopServerToolsWhenMaxTokensUsedType](../../models/components/stopservertoolswhenmaxtokensusedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/stopservertoolswhenstepcountis.mdx b/docs/models/components/stopservertoolswhenstepcountis.mdx index 4c7ca7c2..7e2f0015 100644 --- a/docs/models/components/stopservertoolswhenstepcountis.mdx +++ b/docs/models/components/stopservertoolswhenstepcountis.mdx @@ -10,4 +10,4 @@ Stop after the agent loop has executed this many steps. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `StepCount` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.StopServerToolsWhenStepCountIsType](../../models/components/stopservertoolswhenstepcountistype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.StopServerToolsWhenStepCountIsType](../../models/components/stopservertoolswhenstepcountistype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/storedprompttemplate.mdx b/docs/models/components/storedprompttemplate.mdx index 9a13ae6c..8c5d7a79 100644 --- a/docs/models/components/storedprompttemplate.mdx +++ b/docs/models/components/storedprompttemplate.mdx @@ -7,4 +7,4 @@ title: "StoredPromptTemplate" | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | N/A | -| `Variables` | optionalnullable.OptionalNullable[map[string][components.Variables](../../models/components/variables.mdx)] | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Variables` | optionalnullable.OptionalNullable[map[string][components.Variables](../../models/components/variables)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/streameventsresponsecompleted.mdx b/docs/models/components/streameventsresponsecompleted.mdx index 954b61fb..f576a665 100644 --- a/docs/models/components/streameventsresponsecompleted.mdx +++ b/docs/models/components/streameventsresponsecompleted.mdx @@ -9,6 +9,6 @@ Event emitted when a response has completed successfully | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/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
}
} | +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult) | :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` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseCompletedType](../../models/components/streameventsresponsecompletedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.StreamEventsResponseCompletedType](../../models/components/streameventsresponsecompletedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponsefailed.mdx b/docs/models/components/streameventsresponsefailed.mdx index bcc56b0d..10bee50d 100644 --- a/docs/models/components/streameventsresponsefailed.mdx +++ b/docs/models/components/streameventsresponsefailed.mdx @@ -9,6 +9,6 @@ Event emitted when a response has failed | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/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
}
} | +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult) | :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` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseFailedType](../../models/components/streameventsresponsefailedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.StreamEventsResponseFailedType](../../models/components/streameventsresponsefailedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponseincomplete.mdx b/docs/models/components/streameventsresponseincomplete.mdx index 5f90aadd..5ea76350 100644 --- a/docs/models/components/streameventsresponseincomplete.mdx +++ b/docs/models/components/streameventsresponseincomplete.mdx @@ -9,6 +9,6 @@ Event emitted when a response is incomplete | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Response` | [components.OpenResponsesResult](../../models/components/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
}
} | +| `Response` | [components.OpenResponsesResult](../../models/components/openresponsesresult) | :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` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseIncompleteType](../../models/components/streameventsresponseincompletetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.StreamEventsResponseIncompleteType](../../models/components/streameventsresponseincompletetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponseoutputitemadded.mdx b/docs/models/components/streameventsresponseoutputitemadded.mdx index 17f170a7..023e0553 100644 --- a/docs/models/components/streameventsresponseoutputitemadded.mdx +++ b/docs/models/components/streameventsresponseoutputitemadded.mdx @@ -9,7 +9,7 @@ Event emitted when a new output item is added to the response | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | :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"
} | +| `Item` | [components.OutputItems](../../models/components/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` | `int64` | :heavy_check_mark: | N/A | | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseOutputItemAddedType](../../models/components/streameventsresponseoutputitemaddedtype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.StreamEventsResponseOutputItemAddedType](../../models/components/streameventsresponseoutputitemaddedtype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streameventsresponseoutputitemdone.mdx b/docs/models/components/streameventsresponseoutputitemdone.mdx index 78dd4200..b16a34ef 100644 --- a/docs/models/components/streameventsresponseoutputitemdone.mdx +++ b/docs/models/components/streameventsresponseoutputitemdone.mdx @@ -9,7 +9,7 @@ Event emitted when an output item is complete | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Item` | [components.OutputItems](../../models/components/outputitems.mdx) | :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"
} | +| `Item` | [components.OutputItems](../../models/components/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` | `int64` | :heavy_check_mark: | N/A | | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | -| `Type` | [components.StreamEventsResponseOutputItemDoneType](../../models/components/streameventsresponseoutputitemdonetype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Type` | [components.StreamEventsResponseOutputItemDoneType](../../models/components/streameventsresponseoutputitemdonetype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/streamlogprob.mdx b/docs/models/components/streamlogprob.mdx index 4868841c..bbf0e9fa 100644 --- a/docs/models/components/streamlogprob.mdx +++ b/docs/models/components/streamlogprob.mdx @@ -12,4 +12,4 @@ Log probability information for a token | `Bytes` | []`int64` | :heavy_minus_sign: | N/A | | `Logprob` | `float64` | :heavy_check_mark: | N/A | | `Token` | `string` | :heavy_check_mark: | N/A | -| `TopLogprobs` | [][components.StreamLogprobTopLogprob](../../models/components/streamlogprobtoplogprob.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `TopLogprobs` | [][components.StreamLogprobTopLogprob](../../models/components/streamlogprobtoplogprob) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/sttrequest.mdx b/docs/models/components/sttrequest.mdx index f76e1c42..d85525f7 100644 --- a/docs/models/components/sttrequest.mdx +++ b/docs/models/components/sttrequest.mdx @@ -9,10 +9,10 @@ Speech-to-text request input. Accepts a JSON body with input_audio containing ba | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `InputAudio` | [components.STTInputAudio](../../models/components/sttinputaudio.mdx) | :heavy_check_mark: | Base64-encoded audio to transcribe | \{
"data": "UklGRiQA...",
"format": "wav"
} | +| `InputAudio` | [components.STTInputAudio](../../models/components/sttinputaudio) | :heavy_check_mark: | Base64-encoded audio to transcribe | \{
"data": "UklGRiQA...",
"format": "wav"
} | | `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` | [*components.STTRequestProvider](../../models/components/sttrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `ResponseFormat` | [*components.STTRequestResponseFormat](../../models/components/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 | +| `Provider` | [*components.STTRequestProvider](../../models/components/sttrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | +| `ResponseFormat` | [*components.STTRequestResponseFormat](../../models/components/sttrequestresponseformat) | :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 | | `Temperature` | `*float64` | :heavy_minus_sign: | Sampling temperature for transcription | 0 | -| `TimestampGranularities` | [][components.STTTimestampGranularity](../../models/components/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"
] | \ No newline at end of file +| `TimestampGranularities` | [][components.STTTimestampGranularity](../../models/components/stttimestampgranularity) | :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"
] | \ No newline at end of file diff --git a/docs/models/components/sttrequestprovider.mdx b/docs/models/components/sttrequestprovider.mdx index 658722a6..21832ee2 100644 --- a/docs/models/components/sttrequestprovider.mdx +++ b/docs/models/components/sttrequestprovider.mdx @@ -9,4 +9,4 @@ Provider-specific passthrough configuration | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Options` | [*components.ProviderOptions](../../models/components/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
}
} | \ No newline at end of file +| `Options` | [*components.ProviderOptions](../../models/components/provideroptions) | :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
}
} | \ No newline at end of file diff --git a/docs/models/components/sttresponse.mdx b/docs/models/components/sttresponse.mdx index af35c3c3..16232d21 100644 --- a/docs/models/components/sttresponse.mdx +++ b/docs/models/components/sttresponse.mdx @@ -11,8 +11,8 @@ STT response containing transcribed text and optional usage statistics | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `Duration` | `*float64` | :heavy_minus_sign: | Duration of the input audio in seconds, present when response_format is verbose_json | 9.2 | | `Language` | `*string` | :heavy_minus_sign: | Detected or forced language, present when response_format is verbose_json | english | -| `Segments` | [][components.STTSegment](../../models/components/sttsegment.mdx) | :heavy_minus_sign: | Timestamped transcript segments, present when response_format is verbose_json | | +| `Segments` | [][components.STTSegment](../../models/components/sttsegment) | :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` | [*components.STTUsage](../../models/components/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` | [][components.STTWord](../../models/components/sttword.mdx) | :heavy_minus_sign: | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file +| `Usage` | [*components.STTUsage](../../models/components/sttusage) | :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` | [][components.STTWord](../../models/components/sttword) | :heavy_minus_sign: | Timestamped words, present when the provider returns word-level timestamps | | \ No newline at end of file diff --git a/docs/models/components/subagentreasoning.mdx b/docs/models/components/subagentreasoning.mdx index 50174b07..cd592edb 100644 --- a/docs/models/components/subagentreasoning.mdx +++ b/docs/models/components/subagentreasoning.mdx @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the subagent call. Use this to control reas | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `Effort` | [*components.SubagentReasoningEffort](../../models/components/subagentreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the subagent call. | +| `Effort` | [*components.SubagentReasoningEffort](../../models/components/subagentreasoningeffort) | :heavy_minus_sign: | Reasoning effort level for the subagent call. | | `MaxTokens` | `*int64` | :heavy_minus_sign: | Maximum number of reasoning tokens the subagent may use. Accepted and validated but not yet forwarded to the subagent call. | \ No newline at end of file diff --git a/docs/models/components/subagentservertoolconfig.mdx b/docs/models/components/subagentservertoolconfig.mdx index dcf91d3d..58ed2f67 100644 --- a/docs/models/components/subagentservertoolconfig.mdx +++ b/docs/models/components/subagentservertoolconfig.mdx @@ -14,6 +14,6 @@ Configuration for one openrouter:subagent server tool entry. | `MaxToolCalls` | `*int64` | :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. Accepted and validated but not yet enforced on the subagent call. | 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` | [*components.SubagentReasoning](../../models/components/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"
} | +| `Reasoning` | [*components.SubagentReasoning](../../models/components/subagentreasoning) | :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` | `*float64` | :heavy_minus_sign: | Sampling temperature forwarded to the subagent call. When omitted, the provider's default applies. | 0.7 | -| `Tools` | [][components.SubagentNestedTool](../../models/components/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 +| `Tools` | [][components.SubagentNestedTool](../../models/components/subagentnestedtool) | :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 diff --git a/docs/models/components/subagentservertoolopenrouter.mdx b/docs/models/components/subagentservertoolopenrouter.mdx index b14fa52d..dccb7871 100644 --- a/docs/models/components/subagentservertoolopenrouter.mdx +++ b/docs/models/components/subagentservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: delegates self-contained tasks to a smaller, ch | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.SubagentServerToolConfig](../../models/components/subagentservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | -| `Type` | [components.SubagentServerToolOpenRouterType](../../models/components/subagentservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.SubagentServerToolConfig](../../models/components/subagentservertoolconfig) | :heavy_minus_sign: | Configuration for one openrouter:subagent server tool entry. | \{
"model": "~anthropic/claude-haiku-latest",
"name": "summarizer"
} | +| `Type` | [components.SubagentServerToolOpenRouterType](../../models/components/subagentservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/submitgenerationfeedbackrequest.mdx b/docs/models/components/submitgenerationfeedbackrequest.mdx index 54d284ae..afed38bd 100644 --- a/docs/models/components/submitgenerationfeedbackrequest.mdx +++ b/docs/models/components/submitgenerationfeedbackrequest.mdx @@ -9,6 +9,6 @@ Structured feedback about a specific generation | Field | Type | Required | Description | Example | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Category` | [components.Category](../../models/components/category.mdx) | :heavy_check_mark: | The category of feedback being reported | incorrect_response | +| `Category` | [components.Category](../../models/components/category) | :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 diff --git a/docs/models/components/submitgenerationfeedbackresponse.mdx b/docs/models/components/submitgenerationfeedbackresponse.mdx index c4c9de38..030c3938 100644 --- a/docs/models/components/submitgenerationfeedbackresponse.mdx +++ b/docs/models/components/submitgenerationfeedbackresponse.mdx @@ -9,4 +9,4 @@ Confirmation that the feedback was recorded | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.SubmitGenerationFeedbackResponseData](../../models/components/submitgenerationfeedbackresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.SubmitGenerationFeedbackResponseData](../../models/components/submitgenerationfeedbackresponsedata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/taskbudget.mdx b/docs/models/components/taskbudget.mdx index c59ed570..2c0924cf 100644 --- a/docs/models/components/taskbudget.mdx +++ b/docs/models/components/taskbudget.mdx @@ -11,4 +11,4 @@ Task budget for an agentic turn. The model sees a countdown of remaining tokens | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | `Remaining` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | `Total` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeTokens](../../models/components/typetokens.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeTokens](../../models/components/typetokens) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/taskclassificationitem.mdx b/docs/models/components/taskclassificationitem.mdx index a045e9e5..49047532 100644 --- a/docs/models/components/taskclassificationitem.mdx +++ b/docs/models/components/taskclassificationitem.mdx @@ -10,7 +10,7 @@ title: "TaskClassificationItem" | `CategoryUsageShare` | `float64` | :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` | [][components.TaskClassificationModel](../../models/components/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. | | +| `Models` | [][components.TaskClassificationModel](../../models/components/taskclassificationmodel) | :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` | `float64` | :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` | `float64` | :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 diff --git a/docs/models/components/taskclassificationresponse.mdx b/docs/models/components/taskclassificationresponse.mdx index 2e98b322..0f4818f4 100644 --- a/docs/models/components/taskclassificationresponse.mdx +++ b/docs/models/components/taskclassificationresponse.mdx @@ -6,4 +6,4 @@ title: "TaskClassificationResponse" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `Data` | [components.TaskClassificationResponseData](../../models/components/taskclassificationresponsedata.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [components.TaskClassificationResponseData](../../models/components/taskclassificationresponsedata) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/taskclassificationresponsedata.mdx b/docs/models/components/taskclassificationresponsedata.mdx index 829d78b7..87f8dd09 100644 --- a/docs/models/components/taskclassificationresponsedata.mdx +++ b/docs/models/components/taskclassificationresponsedata.mdx @@ -7,6 +7,6 @@ title: "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` | [][components.TaskClassificationItem](../../models/components/taskclassificationitem.mdx) | :heavy_check_mark: | Per-task classification market-share data, sorted by usage_share descending. | | -| `MacroCategories` | [][components.TaskClassificationMacroCategory](../../models/components/taskclassificationmacrocategory.mdx) | :heavy_check_mark: | Aggregate market-share data per macro-category (code, data, agent, general). | | +| `Classifications` | [][components.TaskClassificationItem](../../models/components/taskclassificationitem) | :heavy_check_mark: | Per-task classification market-share data, sorted by usage_share descending. | | +| `MacroCategories` | [][components.TaskClassificationMacroCategory](../../models/components/taskclassificationmacrocategory) | :heavy_check_mark: | Aggregate market-share data per macro-category (code, data, agent, general). | | | `WindowDays` | `int64` | :heavy_check_mark: | Number of trailing days covered by this snapshot. | 7 | \ No newline at end of file diff --git a/docs/models/components/textdeltaevent.mdx b/docs/models/components/textdeltaevent.mdx index a59e7d5a..979b4f16 100644 --- a/docs/models/components/textdeltaevent.mdx +++ b/docs/models/components/textdeltaevent.mdx @@ -12,7 +12,7 @@ Event emitted when a text delta is streamed | `ContentIndex` | `int64` | :heavy_check_mark: | N/A | | `Delta` | `string` | :heavy_check_mark: | N/A | | `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | :heavy_check_mark: | N/A | +| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob) | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.TextDeltaEventType](../../models/components/textdeltaeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TextDeltaEventType](../../models/components/textdeltaeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/textdoneevent.mdx b/docs/models/components/textdoneevent.mdx index 3f947ad4..3c461f89 100644 --- a/docs/models/components/textdoneevent.mdx +++ b/docs/models/components/textdoneevent.mdx @@ -11,8 +11,8 @@ Event emitted when text streaming is complete | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `ContentIndex` | `int64` | :heavy_check_mark: | N/A | | `ItemID` | `string` | :heavy_check_mark: | N/A | -| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob.mdx) | :heavy_check_mark: | N/A | +| `Logprobs` | [][components.StreamLogprob](../../models/components/streamlogprob) | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | | `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TextDoneEventType](../../models/components/textdoneeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TextDoneEventType](../../models/components/textdoneeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/textextendedconfig.mdx b/docs/models/components/textextendedconfig.mdx index 908cb333..f74c37bc 100644 --- a/docs/models/components/textextendedconfig.mdx +++ b/docs/models/components/textextendedconfig.mdx @@ -9,5 +9,5 @@ Text output configuration including format and verbosity | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `Format` | [*components.Formats](../../models/components/formats.mdx) | :heavy_minus_sign: | Text response format configuration | \{
"type": "text"
} | -| `Verbosity` | optionalnullable.OptionalNullable[[components.Verbosity](../../models/components/verbosity.mdx)] | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Format` | [*components.Formats](../../models/components/formats) | :heavy_minus_sign: | Text response format configuration | \{
"type": "text"
} | +| `Verbosity` | optionalnullable.OptionalNullable[[components.Verbosity](../../models/components/verbosity)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/thinkingadaptive.mdx b/docs/models/components/thinkingadaptive.mdx index 3bd1390d..a743d6bc 100644 --- a/docs/models/components/thinkingadaptive.mdx +++ b/docs/models/components/thinkingadaptive.mdx @@ -6,5 +6,5 @@ title: "ThinkingAdaptive" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | :heavy_minus_sign: | N/A | summarized | -| `Type` | [components.TypeAdaptive](../../models/components/typeadaptive.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay)] | :heavy_minus_sign: | N/A | summarized | +| `Type` | [components.TypeAdaptive](../../models/components/typeadaptive) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/thinkingdisabled.mdx b/docs/models/components/thinkingdisabled.mdx index e60601c3..922d97f8 100644 --- a/docs/models/components/thinkingdisabled.mdx +++ b/docs/models/components/thinkingdisabled.mdx @@ -6,4 +6,4 @@ title: "ThinkingDisabled" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `Type` | [components.TypeDisabled](../../models/components/typedisabled.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeDisabled](../../models/components/typedisabled) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/thinkingenabled.mdx b/docs/models/components/thinkingenabled.mdx index ae5baabe..5eceefc5 100644 --- a/docs/models/components/thinkingenabled.mdx +++ b/docs/models/components/thinkingenabled.mdx @@ -7,5 +7,5 @@ title: "ThinkingEnabled" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `BudgetTokens` | `int64` | :heavy_check_mark: | N/A | | -| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay.mdx)] | :heavy_minus_sign: | N/A | summarized | -| `Type` | [components.TypeEnabled](../../models/components/typeenabled.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Display` | optionalnullable.OptionalNullable[[components.AnthropicThinkingDisplay](../../models/components/anthropicthinkingdisplay)] | :heavy_minus_sign: | N/A | summarized | +| `Type` | [components.TypeEnabled](../../models/components/typeenabled) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/timings.mdx b/docs/models/components/timings.mdx index aae63d65..187acfcf 100644 --- a/docs/models/components/timings.mdx +++ b/docs/models/components/timings.mdx @@ -7,5 +7,5 @@ title: "Timings" | Field | Type | Required | Description | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | `EpochMs` | `int64` | :heavy_check_mark: | N/A | -| `Event` | [components.Event](../../models/components/event.mdx) | :heavy_check_mark: | N/A | +| `Event` | [components.Event](../../models/components/event) | :heavy_check_mark: | N/A | | `StartMs` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/tooladvisor20260301.mdx b/docs/models/components/tooladvisor20260301.mdx index 7f655610..e033f1ac 100644 --- a/docs/models/components/tooladvisor20260301.mdx +++ b/docs/models/components/tooladvisor20260301.mdx @@ -6,11 +6,11 @@ title: "ToolAdvisor20260301" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | optionalnullable.OptionalNullable[[components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective.mdx)] | :heavy_minus_sign: | N/A | \{
"type": "ephemeral"
} | +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers) | :heavy_minus_sign: | N/A | [
"direct"
] | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | optionalnullable.OptionalNullable[[components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective)] | :heavy_minus_sign: | N/A | \{
"type": "ephemeral"
} | | `DeferLoading` | `*bool` | :heavy_minus_sign: | N/A | | | `MaxUses` | `*int64` | :heavy_minus_sign: | N/A | | | `Model` | `string` | :heavy_check_mark: | N/A | | -| `Name` | [components.NameAdvisor](../../models/components/nameadvisor.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeAdvisor20260301](../../models/components/typeadvisor20260301.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Name` | [components.NameAdvisor](../../models/components/nameadvisor) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeAdvisor20260301](../../models/components/typeadvisor20260301) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolbash20250124.mdx b/docs/models/components/toolbash20250124.mdx index 6b1fa0de..86609f5a 100644 --- a/docs/models/components/toolbash20250124.mdx +++ b/docs/models/components/toolbash20250124.mdx @@ -6,6 +6,6 @@ title: "ToolBash20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [components.NameBash](../../models/components/namebash.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeBash20250124](../../models/components/typebash20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [components.NameBash](../../models/components/namebash) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeBash20250124](../../models/components/typebash20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolchoiceallowed.mdx b/docs/models/components/toolchoiceallowed.mdx index 39e02a06..7cdfb961 100644 --- a/docs/models/components/toolchoiceallowed.mdx +++ b/docs/models/components/toolchoiceallowed.mdx @@ -9,6 +9,6 @@ Constrains the model to a pre-defined set of allowed tools | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `Mode` | [components.Mode](../../models/components/mode.mdx) | :heavy_check_mark: | N/A | +| `Mode` | [components.Mode](../../models/components/mode) | :heavy_check_mark: | N/A | | `Tools` | []map[string]`any` | :heavy_check_mark: | N/A | -| `Type` | [components.ToolChoiceAllowedType](../../models/components/toolchoiceallowedtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ToolChoiceAllowedType](../../models/components/toolchoiceallowedtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoiceany.mdx b/docs/models/components/toolchoiceany.mdx index 0896d157..db606d79 100644 --- a/docs/models/components/toolchoiceany.mdx +++ b/docs/models/components/toolchoiceany.mdx @@ -7,4 +7,4 @@ title: "ToolChoiceAny" | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | -| `Type` | [components.TypeAny](../../models/components/typeany.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeAny](../../models/components/typeany) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoiceauto.mdx b/docs/models/components/toolchoiceauto.mdx index 41a39188..e8f9f128 100644 --- a/docs/models/components/toolchoiceauto.mdx +++ b/docs/models/components/toolchoiceauto.mdx @@ -7,4 +7,4 @@ title: "ToolChoiceAuto" | Field | Type | Required | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | | `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | -| `Type` | [components.ToolChoiceTypeAuto](../../models/components/toolchoicetypeauto.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.ToolChoiceTypeAuto](../../models/components/toolchoicetypeauto) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoicenone.mdx b/docs/models/components/toolchoicenone.mdx index 0b431b9a..5317d9c8 100644 --- a/docs/models/components/toolchoicenone.mdx +++ b/docs/models/components/toolchoicenone.mdx @@ -6,4 +6,4 @@ title: "ToolChoiceNone" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Type` | [components.TypeNone](../../models/components/typenone.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeNone](../../models/components/typenone) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolchoicetool.mdx b/docs/models/components/toolchoicetool.mdx index 42539fc3..7ec55316 100644 --- a/docs/models/components/toolchoicetool.mdx +++ b/docs/models/components/toolchoicetool.mdx @@ -8,4 +8,4 @@ title: "ToolChoiceTool" | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `DisableParallelToolUse` | `*bool` | :heavy_minus_sign: | N/A | | `Name` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.TypeTool](../../models/components/typetool.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.TypeTool](../../models/components/typetool) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/toolcustom.mdx b/docs/models/components/toolcustom.mdx index 9b0f1fa4..d00d169a 100644 --- a/docs/models/components/toolcustom.mdx +++ b/docs/models/components/toolcustom.mdx @@ -6,9 +6,9 @@ title: "ToolCustom" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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"
} | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | `*bool` | :heavy_minus_sign: | N/A | | | `Description` | `*string` | :heavy_minus_sign: | N/A | | -| `InputSchema` | [components.InputSchema](../../models/components/inputschema.mdx) | :heavy_check_mark: | N/A | | +| `InputSchema` | [components.InputSchema](../../models/components/inputschema) | :heavy_check_mark: | N/A | | | `Name` | `string` | :heavy_check_mark: | N/A | | -| `Type` | [*components.ToolTypeCustom](../../models/components/tooltypecustom.mdx) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `Type` | [*components.ToolTypeCustom](../../models/components/tooltypecustom) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/components/tooltexteditor20250124.mdx b/docs/models/components/tooltexteditor20250124.mdx index 5ae15508..27f915b6 100644 --- a/docs/models/components/tooltexteditor20250124.mdx +++ b/docs/models/components/tooltexteditor20250124.mdx @@ -6,6 +6,6 @@ title: "ToolTextEditor20250124" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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` | [components.NameStrReplaceEditor](../../models/components/namestrreplaceeditor.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeTextEditor20250124](../../models/components/typetexteditor20250124.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | [components.NameStrReplaceEditor](../../models/components/namestrreplaceeditor) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeTextEditor20250124](../../models/components/typetexteditor20250124) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/toolwebsearch20250305.mdx b/docs/models/components/toolwebsearch20250305.mdx index a3da6884..b90290cc 100644 --- a/docs/models/components/toolwebsearch20250305.mdx +++ b/docs/models/components/toolwebsearch20250305.mdx @@ -8,8 +8,8 @@ title: "ToolWebSearch20250305" | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | | `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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"
} | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Name` | [components.NameWebSearch1](../../models/components/namewebsearch1.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeWebSearch20250305](../../models/components/typewebsearch20250305.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/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 +| `Name` | [components.NameWebSearch1](../../models/components/namewebsearch1) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeWebSearch20250305](../../models/components/typewebsearch20250305) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation)] | :heavy_minus_sign: | 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/components/toolwebsearch20260209.mdx b/docs/models/components/toolwebsearch20260209.mdx index 0526f22d..77dfa2ac 100644 --- a/docs/models/components/toolwebsearch20260209.mdx +++ b/docs/models/components/toolwebsearch20260209.mdx @@ -6,11 +6,11 @@ title: "ToolWebSearch20260209" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers.mdx) | :heavy_minus_sign: | N/A | [
"direct"
] | +| `AllowedCallers` | [][components.AnthropicAllowedCallers](../../models/components/anthropicallowedcallers) | :heavy_minus_sign: | N/A | [
"direct"
] | | `AllowedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | | `BlockedDomains` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | N/A | | -| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/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"
} | +| `CacheControl` | [*components.AnthropicCacheControlDirective](../../models/components/anthropiccachecontroldirective) | :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` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | | -| `Name` | [components.NameWebSearch2](../../models/components/namewebsearch2.mdx) | :heavy_check_mark: | N/A | | -| `Type` | [components.TypeWebSearch20260209](../../models/components/typewebsearch20260209.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/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 +| `Name` | [components.NameWebSearch2](../../models/components/namewebsearch2) | :heavy_check_mark: | N/A | | +| `Type` | [components.TypeWebSearch20260209](../../models/components/typewebsearch20260209) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.AnthropicWebSearchToolUserLocation](../../models/components/anthropicwebsearchtooluserlocation)] | :heavy_minus_sign: | 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/components/triggerinputtokens.mdx b/docs/models/components/triggerinputtokens.mdx index c03547ab..29078f6c 100644 --- a/docs/models/components/triggerinputtokens.mdx +++ b/docs/models/components/triggerinputtokens.mdx @@ -6,5 +6,5 @@ title: "TriggerInputTokens" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.EditTypeInputTokens](../../models/components/edittypeinputtokens.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.EditTypeInputTokens](../../models/components/edittypeinputtokens) | :heavy_check_mark: | N/A | | `Value` | `int64` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksaaitem.mdx b/docs/models/components/unifiedbenchmarksaaitem.mdx index 232deb49..59e6f868 100644 --- a/docs/models/components/unifiedbenchmarksaaitem.mdx +++ b/docs/models/components/unifiedbenchmarksaaitem.mdx @@ -11,5 +11,5 @@ title: "UnifiedBenchmarksAAItem" | `DisplayName` | `string` | :heavy_check_mark: | Model name as listed on Artificial Analysis. | GPT-4o | | `IntelligenceIndex` | `*float64` | :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` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `Source` | [components.UnifiedBenchmarksAAItemSource](../../models/components/unifiedbenchmarksaaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | \ No newline at end of file +| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `Source` | [components.UnifiedBenchmarksAAItemSource](../../models/components/unifiedbenchmarksaaitemsource) | :heavy_check_mark: | Benchmark source discriminator. | | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksdaitem.mdx b/docs/models/components/unifiedbenchmarksdaitem.mdx index e5583811..dc01302e 100644 --- a/docs/models/components/unifiedbenchmarksdaitem.mdx +++ b/docs/models/components/unifiedbenchmarksdaitem.mdx @@ -12,7 +12,7 @@ title: "UnifiedBenchmarksDAItem" | `DisplayName` | `string` | :heavy_check_mark: | Human-readable model name from Design Arena. | Claude Sonnet 4 | | `Elo` | `float64` | :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` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing.mdx) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | -| `Source` | [components.UnifiedBenchmarksDAItemSource](../../models/components/unifiedbenchmarksdaitemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | -| `TournamentStats` | [components.TournamentStats](../../models/components/tournamentstats.mdx) | :heavy_check_mark: | Placement distribution from tournament matches. | | +| `Pricing` | [*components.UnifiedBenchmarkPricing](../../models/components/unifiedbenchmarkpricing) | :heavy_check_mark: | OpenRouter pricing per token for this model. Null if pricing is unavailable. | \{
"completion": "0.000015",
"prompt": "0.000003"
} | +| `Source` | [components.UnifiedBenchmarksDAItemSource](../../models/components/unifiedbenchmarksdaitemsource) | :heavy_check_mark: | Benchmark source discriminator. | | +| `TournamentStats` | [components.TournamentStats](../../models/components/tournamentstats) | :heavy_check_mark: | Placement distribution from tournament matches. | | | `WinRate` | `float64` | :heavy_check_mark: | Win rate as a percentage (0–100). | 72 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksmeta.mdx b/docs/models/components/unifiedbenchmarksmeta.mdx index d5e63e71..36c7bc0e 100644 --- a/docs/models/components/unifiedbenchmarksmeta.mdx +++ b/docs/models/components/unifiedbenchmarksmeta.mdx @@ -9,7 +9,7 @@ title: "UnifiedBenchmarksMeta" | `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` | `int64` | :heavy_check_mark: | Number of unique models in the response. | | -| `Source` | [*components.UnifiedBenchmarksMetaSource](../../models/components/unifiedbenchmarksmetasource.mdx) | :heavy_check_mark: | The source filter applied, or null when all sources are returned. | artificial-analysis | +| `Source` | [*components.UnifiedBenchmarksMetaSource](../../models/components/unifiedbenchmarksmetasource) | :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` | [components.UnifiedBenchmarksMetaVersion](../../models/components/unifiedbenchmarksmetaversion.mdx) | :heavy_check_mark: | Dataset version. | | \ No newline at end of file +| `Version` | [components.UnifiedBenchmarksMetaVersion](../../models/components/unifiedbenchmarksmetaversion) | :heavy_check_mark: | Dataset version. | | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksoritem.mdx b/docs/models/components/unifiedbenchmarksoritem.mdx index dccf2426..26731243 100644 --- a/docs/models/components/unifiedbenchmarksoritem.mdx +++ b/docs/models/components/unifiedbenchmarksoritem.mdx @@ -9,9 +9,9 @@ title: "UnifiedBenchmarksORItem" | `Accuracy` | `float64` | :heavy_check_mark: | Aggregate accuracy score from 0 to 1. Higher is better. | 0.72 | | `AccuracyStddev` | `*float64` | :heavy_check_mark: | Standard deviation of run accuracy, or null for a single run. | 0.03 | | `AvgCostPerTask` | `*float64` | :heavy_check_mark: | Average cost per task in USD, or null if unavailable. | 0.002 | -| `BenchmarkType` | [components.BenchmarkType](../../models/components/benchmarktype.mdx) | :heavy_check_mark: | OpenRouter benchmark evaluation type. | gpqa_diamond | +| `BenchmarkType` | [components.BenchmarkType](../../models/components/benchmarktype) | :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` | [components.UnifiedBenchmarksORItemSource](../../models/components/unifiedbenchmarksoritemsource.mdx) | :heavy_check_mark: | Benchmark source discriminator. | | +| `Source` | [components.UnifiedBenchmarksORItemSource](../../models/components/unifiedbenchmarksoritemsource) | :heavy_check_mark: | Benchmark source discriminator. | | | `TotalTasks` | `int64` | :heavy_check_mark: | Total benchmark tasks across runs. | 300 | \ No newline at end of file diff --git a/docs/models/components/unifiedbenchmarksresponse.mdx b/docs/models/components/unifiedbenchmarksresponse.mdx index d3443764..99d6a3ed 100644 --- a/docs/models/components/unifiedbenchmarksresponse.mdx +++ b/docs/models/components/unifiedbenchmarksresponse.mdx @@ -6,5 +6,5 @@ title: "UnifiedBenchmarksResponse" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [][components.UnifiedBenchmarksResponseData](../../models/components/unifiedbenchmarksresponsedata.mdx) | :heavy_check_mark: | N/A | | -| `Meta` | [components.UnifiedBenchmarksMeta](../../models/components/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` | [][components.UnifiedBenchmarksResponseData](../../models/components/unifiedbenchmarksresponsedata) | :heavy_check_mark: | N/A | | +| `Meta` | [components.UnifiedBenchmarksMeta](../../models/components/unifiedbenchmarksmeta) | :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 diff --git a/docs/models/components/updatebyokkeyresponse.mdx b/docs/models/components/updatebyokkeyresponse.mdx index 2d9f51da..7bfa6a27 100644 --- a/docs/models/components/updatebyokkeyresponse.mdx +++ b/docs/models/components/updatebyokkeyresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateBYOKKeyResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.BYOKKey](../../models/components/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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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` | [components.BYOKKey](../../models/components/byokkey) | :heavy_check_mark: | N/A | \{
"allowed_api_key_hashes": null,
"allowed_models": null,
"allowed_user_ids": null,
"created_at": "2025-08-24T10:30:00Z",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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/components/updateguardrailrequest.mdx b/docs/models/components/updateguardrailrequest.mdx index f37c26da..a427769a 100644 --- a/docs/models/components/updateguardrailrequest.mdx +++ b/docs/models/components/updateguardrailrequest.mdx @@ -8,8 +8,8 @@ title: "UpdateGuardrailRequest" | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AllowedModels` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | Array of model identifiers (slug or canonical_slug accepted) | [
"openai/gpt-5.2"
] | | `AllowedProviders` | optionalnullable.OptionalNullable[[]`string`] | :heavy_minus_sign: | New list of allowed provider IDs | [
"openai",
"anthropic",
"deepseek"
] | -| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/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` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry.mdx)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | +| `ContentFilterBuiltins` | optionalnullable.OptionalNullable[[][components.ContentFilterBuiltinEntryInput](../../models/components/contentfilterbuiltinentryinput)] | :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` | optionalnullable.OptionalNullable[[][components.ContentFilterEntry](../../models/components/contentfilterentry)] | :heavy_minus_sign: | Custom regex content filters to apply. Set to null to remove. | null | | `Description` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | New description for the guardrail | Updated description | | `EnableFreeModelPublication` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that publish prompts. | false | | `EnableFreeModelTraining` | optionalnullable.OptionalNullable[`bool`] | :heavy_minus_sign: | Whether this guardrail allows free endpoints that train on request data. | true | @@ -25,4 +25,4 @@ title: "UpdateGuardrailRequest" | `IncludeByokInBudgets` | `*bool` | :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` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | New spending limit in USD | 75 | | `Name` | `*string` | :heavy_minus_sign: | New name for the guardrail | Updated Guardrail Name | -| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval.mdx)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file +| `ResetInterval` | optionalnullable.OptionalNullable[[components.GuardrailInterval](../../models/components/guardrailinterval)] | :heavy_minus_sign: | Interval at which the limit resets (daily, weekly, monthly) | monthly | \ No newline at end of file diff --git a/docs/models/components/updateguardrailresponse.mdx b/docs/models/components/updateguardrailresponse.mdx index e0ab3f6c..25c82baf 100644 --- a/docs/models/components/updateguardrailresponse.mdx +++ b/docs/models/components/updateguardrailresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateGuardrailResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Guardrail](../../models/components/guardrail.mdx) | :heavy_check_mark: | N/A | \{
"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` | [components.Guardrail](../../models/components/guardrail) | :heavy_check_mark: | N/A | \{
"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/components/updateobservabilitydestinationrequest.mdx b/docs/models/components/updateobservabilitydestinationrequest.mdx index c8447131..178b7751 100644 --- a/docs/models/components/updateobservabilitydestinationrequest.mdx +++ b/docs/models/components/updateobservabilitydestinationrequest.mdx @@ -9,7 +9,7 @@ title: "UpdateObservabilityDestinationRequest" | `APIKeyHashes` | optionalnullable.OptionalNullable[[]`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 | | `Config` | map[string]`any` | :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` | `*bool` | :heavy_minus_sign: | Whether the destination is enabled. | true | -| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable.mdx)] | :heavy_minus_sign: | N/A | null | +| `FilterRules` | optionalnullable.OptionalNullable[[components.ObservabilityFilterRulesConfigNullable](../../models/components/observabilityfilterrulesconfignullable)] | :heavy_minus_sign: | N/A | null | | `Name` | `*string` | :heavy_minus_sign: | Human-readable name for the destination. | Production Langfuse | | `PrivacyMode` | `*bool` | :heavy_minus_sign: | When true, request/response bodies are not forwarded — only metadata. | false | | `SamplingRate` | `*float64` | :heavy_minus_sign: | Sampling rate between 0.0001 and 1 (1 = 100%). | 1 | \ No newline at end of file diff --git a/docs/models/components/updateobservabilitydestinationresponse.mdx b/docs/models/components/updateobservabilitydestinationresponse.mdx index d6b36b45..922226e2 100644 --- a/docs/models/components/updateobservabilitydestinationresponse.mdx +++ b/docs/models/components/updateobservabilitydestinationresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateObservabilityDestinationResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.ObservabilityDestination](../../models/components/observabilitydestination.mdx) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"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,
"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` | [components.ObservabilityDestination](../../models/components/observabilitydestination) | :heavy_check_mark: | N/A | \{
"api_key_hashes": null,
"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,
"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/components/updateworkspaceresponse.mdx b/docs/models/components/updateworkspaceresponse.mdx index 6045ec86..966badcd 100644 --- a/docs/models/components/updateworkspaceresponse.mdx +++ b/docs/models/components/updateworkspaceresponse.mdx @@ -6,4 +6,4 @@ title: "UpdateWorkspaceResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.Workspace](../../models/components/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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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` | [components.Workspace](../../models/components/workspace) | :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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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/components/upsertworkspacebudgetresponse.mdx b/docs/models/components/upsertworkspacebudgetresponse.mdx index 3ba014a7..e3ca2fbf 100644 --- a/docs/models/components/upsertworkspacebudgetresponse.mdx +++ b/docs/models/components/upsertworkspacebudgetresponse.mdx @@ -6,4 +6,4 @@ title: "UpsertWorkspaceBudgetResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Data` | [components.WorkspaceBudget](../../models/components/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"
} | \ No newline at end of file +| `Data` | [components.WorkspaceBudget](../../models/components/workspacebudget) | :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"
} | \ No newline at end of file diff --git a/docs/models/components/urlcitation.mdx b/docs/models/components/urlcitation.mdx index 6ed77177..5aaf9d68 100644 --- a/docs/models/components/urlcitation.mdx +++ b/docs/models/components/urlcitation.mdx @@ -10,5 +10,5 @@ title: "URLCitation" | `EndIndex` | `int64` | :heavy_check_mark: | N/A | | `StartIndex` | `int64` | :heavy_check_mark: | N/A | | `Title` | `string` | :heavy_check_mark: | N/A | -| `Type` | [components.URLCitationType](../../models/components/urlcitationtype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.URLCitationType](../../models/components/urlcitationtype) | :heavy_check_mark: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/usage.mdx b/docs/models/components/usage.mdx index e87877af..a168b656 100644 --- a/docs/models/components/usage.mdx +++ b/docs/models/components/usage.mdx @@ -7,11 +7,11 @@ title: "Usage" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `InputTokens` | `int64` | :heavy_check_mark: | N/A | | -| `InputTokensDetails` | [components.InputTokensDetails](../../models/components/inputtokensdetails.mdx) | :heavy_check_mark: | N/A | | +| `InputTokensDetails` | [components.InputTokensDetails](../../models/components/inputtokensdetails) | :heavy_check_mark: | N/A | | | `OutputTokens` | `int64` | :heavy_check_mark: | N/A | | -| `OutputTokensDetails` | [components.OutputTokensDetails](../../models/components/outputtokensdetails.mdx) | :heavy_check_mark: | N/A | | +| `OutputTokensDetails` | [components.OutputTokensDetails](../../models/components/outputtokensdetails) | :heavy_check_mark: | N/A | | | `TotalTokens` | `int64` | :heavy_check_mark: | N/A | | | `Cost` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Cost of the completion | | -| `CostDetails` | [*components.UsageCostDetails](../../models/components/usagecostdetails.mdx) | :heavy_minus_sign: | N/A | | +| `CostDetails` | [*components.UsageCostDetails](../../models/components/usagecostdetails) | :heavy_minus_sign: | N/A | | | `IsByok` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | -| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/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 +| `ServerToolUseDetails` | optionalnullable.OptionalNullable[[components.ServerToolUseDetails](../../models/components/servertoolusedetails)] | :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 diff --git a/docs/models/components/userlocation.mdx b/docs/models/components/userlocation.mdx index d066e2eb..8669523b 100644 --- a/docs/models/components/userlocation.mdx +++ b/docs/models/components/userlocation.mdx @@ -13,4 +13,4 @@ Approximate user location for location-biased search results. Passed through to | `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [components.WebSearchPluginType](../../models/components/websearchplugintype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.WebSearchPluginType](../../models/components/websearchplugintype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/videogenerationrequest.mdx b/docs/models/components/videogenerationrequest.mdx index 93f84109..cbfe81d5 100644 --- a/docs/models/components/videogenerationrequest.mdx +++ b/docs/models/components/videogenerationrequest.mdx @@ -6,15 +6,15 @@ title: "VideoGenerationRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `AspectRatio` | [*components.VideoGenerationRequestAspectRatio](../../models/components/videogenerationrequestaspectratio.mdx) | :heavy_minus_sign: | Aspect ratio of the generated video | 16:9 | +| `AspectRatio` | [*components.VideoGenerationRequestAspectRatio](../../models/components/videogenerationrequestaspectratio) | :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 | | `Duration` | `*int64` | :heavy_minus_sign: | Duration of the generated video in seconds | 8 | -| `FrameImages` | [][components.FrameImage](../../models/components/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. | | +| `FrameImages` | [][components.FrameImage](../../models/components/frameimage) | :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` | `*bool` | :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` | [][components.InputReference](../../models/components/inputreference.mdx) | :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 (currently BytePlus Seedance 2.0); other providers use image references and ignore the rest. | | +| `InputReferences` | [][components.InputReference](../../models/components/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 (currently BytePlus Seedance 2.0); other providers use image references and ignore the rest. | | | `Model` | `string` | :heavy_check_mark: | N/A | | | `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` | [*components.VideoGenerationRequestProvider](../../models/components/videogenerationrequestprovider.mdx) | :heavy_minus_sign: | Provider-specific passthrough configuration | | -| `Resolution` | [*components.VideoGenerationRequestResolution](../../models/components/videogenerationrequestresolution.mdx) | :heavy_minus_sign: | Resolution of the generated video | 720p | +| `Provider` | [*components.VideoGenerationRequestProvider](../../models/components/videogenerationrequestprovider) | :heavy_minus_sign: | Provider-specific passthrough configuration | | +| `Resolution` | [*components.VideoGenerationRequestResolution](../../models/components/videogenerationrequestresolution) | :heavy_minus_sign: | Resolution of the generated video | 720p | | `Seed` | `*int64` | :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. | | | `Size` | `*string` | :heavy_minus_sign: | Exact pixel dimensions of the generated video in "WIDTHxHEIGHT" format (e.g. "1280x720"). Interchangeable with resolution + aspect_ratio. | 1280x720 | \ No newline at end of file diff --git a/docs/models/components/videogenerationrequestprovider.mdx b/docs/models/components/videogenerationrequestprovider.mdx index aab1e755..929ea3bb 100644 --- a/docs/models/components/videogenerationrequestprovider.mdx +++ b/docs/models/components/videogenerationrequestprovider.mdx @@ -9,4 +9,4 @@ Provider-specific passthrough configuration | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Options` | [*components.VideoGenerationRequestOptions](../../models/components/videogenerationrequestoptions.mdx) | :heavy_minus_sign: | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file +| `Options` | [*components.VideoGenerationRequestOptions](../../models/components/videogenerationrequestoptions) | :heavy_minus_sign: | N/A | \{
"google-vertex": \{
"output_config": \{
"effort": "low"
}
}
} | \ No newline at end of file diff --git a/docs/models/components/videogenerationresponse.mdx b/docs/models/components/videogenerationresponse.mdx index 79807104..1c16aab3 100644 --- a/docs/models/components/videogenerationresponse.mdx +++ b/docs/models/components/videogenerationresponse.mdx @@ -10,6 +10,6 @@ title: "VideoGenerationResponse" | `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: | N/A | | | `PollingURL` | `string` | :heavy_check_mark: | N/A | | -| `Status` | [components.VideoGenerationResponseStatus](../../models/components/videogenerationresponsestatus.mdx) | :heavy_check_mark: | N/A | | +| `Status` | [components.VideoGenerationResponseStatus](../../models/components/videogenerationresponsestatus) | :heavy_check_mark: | N/A | | | `UnsignedUrls` | []`string` | :heavy_minus_sign: | N/A | | -| `Usage` | [*components.VideoGenerationUsage](../../models/components/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 +| `Usage` | [*components.VideoGenerationUsage](../../models/components/videogenerationusage) | :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 diff --git a/docs/models/components/videomodel.mdx b/docs/models/components/videomodel.mdx index 3264b12f..4d45aef1 100644 --- a/docs/models/components/videomodel.mdx +++ b/docs/models/components/videomodel.mdx @@ -16,8 +16,8 @@ title: "VideoModel" | `Name` | `string` | :heavy_check_mark: | Display name of the model | GPT-4 | | `PricingSkus` | optionalnullable.OptionalNullable[map[string]`string`] | :heavy_minus_sign: | Pricing SKUs with provider prefix stripped, values as strings | | | `Seed` | `*bool` | :heavy_check_mark: | Whether the model supports deterministic generation via seed parameter | | -| `SupportedAspectRatios` | [][components.SupportedAspectRatio](../../models/components/supportedaspectratio.mdx) | :heavy_check_mark: | Supported output aspect ratios | | +| `SupportedAspectRatios` | [][components.SupportedAspectRatio](../../models/components/supportedaspectratio) | :heavy_check_mark: | Supported output aspect ratios | | | `SupportedDurations` | []`int64` | :heavy_check_mark: | Supported video durations in seconds | | -| `SupportedFrameImages` | [][components.SupportedFrameImage](../../models/components/supportedframeimage.mdx) | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | -| `SupportedResolutions` | [][components.SupportedResolution](../../models/components/supportedresolution.mdx) | :heavy_check_mark: | Supported output resolutions | | -| `SupportedSizes` | [][components.SupportedSize](../../models/components/supportedsize.mdx) | :heavy_check_mark: | Supported output sizes (width x height) | | \ No newline at end of file +| `SupportedFrameImages` | [][components.SupportedFrameImage](../../models/components/supportedframeimage) | :heavy_check_mark: | Supported frame image types (e.g. first_frame, last_frame) | | +| `SupportedResolutions` | [][components.SupportedResolution](../../models/components/supportedresolution) | :heavy_check_mark: | Supported output resolutions | | +| `SupportedSizes` | [][components.SupportedSize](../../models/components/supportedsize) | :heavy_check_mark: | Supported output sizes (width x height) | | \ No newline at end of file diff --git a/docs/models/components/videomodelslistresponse.mdx b/docs/models/components/videomodelslistresponse.mdx index de05095d..d872a2d6 100644 --- a/docs/models/components/videomodelslistresponse.mdx +++ b/docs/models/components/videomodelslistresponse.mdx @@ -6,4 +6,4 @@ title: "VideoModelsListResponse" | Field | Type | Required | Description | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `Data` | [][components.VideoModel](../../models/components/videomodel.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.VideoModel](../../models/components/videomodel) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/webfetchplugin.mdx b/docs/models/components/webfetchplugin.mdx index da53f869..9ea010ac 100644 --- a/docs/models/components/webfetchplugin.mdx +++ b/docs/models/components/webfetchplugin.mdx @@ -8,6 +8,6 @@ title: "WebFetchPlugin" | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `AllowedDomains` | []`string` | :heavy_minus_sign: | Only fetch from these domains. | | `BlockedDomains` | []`string` | :heavy_minus_sign: | Never fetch from these domains. | -| `ID` | [components.WebFetchPluginID](../../models/components/webfetchpluginid.mdx) | :heavy_check_mark: | N/A | +| `ID` | [components.WebFetchPluginID](../../models/components/webfetchpluginid) | :heavy_check_mark: | N/A | | `MaxContentTokens` | `*int64` | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | | `MaxUses` | `*int64` | :heavy_minus_sign: | 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/components/webfetchservertool.mdx b/docs/models/components/webfetchservertool.mdx index af931347..d2b94afb 100644 --- a/docs/models/components/webfetchservertool.mdx +++ b/docs/models/components/webfetchservertool.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: fetches full content from a URL (web page or PD | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `Parameters` | [*components.WebFetchServerToolConfig](../../models/components/webfetchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | -| `Type` | [components.WebFetchServerToolType](../../models/components/webfetchservertooltype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.WebFetchServerToolConfig](../../models/components/webfetchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:web_fetch server tool | \{
"max_content_tokens": 100000,
"max_uses": 10
} | +| `Type` | [components.WebFetchServerToolType](../../models/components/webfetchservertooltype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/webfetchservertoolconfig.mdx b/docs/models/components/webfetchservertoolconfig.mdx index 34e1d479..b616d85c 100644 --- a/docs/models/components/webfetchservertoolconfig.mdx +++ b/docs/models/components/webfetchservertoolconfig.mdx @@ -11,6 +11,6 @@ Configuration for the openrouter:web_fetch server tool | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AllowedDomains` | []`string` | :heavy_minus_sign: | Only fetch from these domains. | | | `BlockedDomains` | []`string` | :heavy_minus_sign: | Never fetch from these domains. | | -| `Engine` | [*components.WebFetchEngineEnum](../../models/components/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 | +| `Engine` | [*components.WebFetchEngineEnum](../../models/components/webfetchengineenum) | :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` | `*int64` | :heavy_minus_sign: | Maximum content length in approximate tokens. Content exceeding this limit is truncated. | 100000 | | `MaxUses` | `*int64` | :heavy_minus_sign: | 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/components/websearchcallcompletedevent.mdx b/docs/models/components/websearchcallcompletedevent.mdx index 22397fca..148fb005 100644 --- a/docs/models/components/websearchcallcompletedevent.mdx +++ b/docs/models/components/websearchcallcompletedevent.mdx @@ -12,4 +12,4 @@ Web search call completed | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.WebSearchCallCompletedEventType](../../models/components/websearchcallcompletedeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.WebSearchCallCompletedEventType](../../models/components/websearchcallcompletedeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchcallinprogressevent.mdx b/docs/models/components/websearchcallinprogressevent.mdx index 6a868ad8..5493a861 100644 --- a/docs/models/components/websearchcallinprogressevent.mdx +++ b/docs/models/components/websearchcallinprogressevent.mdx @@ -12,4 +12,4 @@ Web search call in progress | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.WebSearchCallInProgressEventType](../../models/components/websearchcallinprogresseventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.WebSearchCallInProgressEventType](../../models/components/websearchcallinprogresseventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchcallsearchingevent.mdx b/docs/models/components/websearchcallsearchingevent.mdx index 7f16925a..4483f141 100644 --- a/docs/models/components/websearchcallsearchingevent.mdx +++ b/docs/models/components/websearchcallsearchingevent.mdx @@ -12,4 +12,4 @@ Web search call is searching | `ItemID` | `string` | :heavy_check_mark: | N/A | | `OutputIndex` | `int64` | :heavy_check_mark: | N/A | | `SequenceNumber` | `int64` | :heavy_check_mark: | N/A | -| `Type` | [components.WebSearchCallSearchingEventType](../../models/components/websearchcallsearchingeventtype.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [components.WebSearchCallSearchingEventType](../../models/components/websearchcallsearchingeventtype) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchconfig.mdx b/docs/models/components/websearchconfig.mdx index 56ea67a9..164d311b 100644 --- a/docs/models/components/websearchconfig.mdx +++ b/docs/models/components/websearchconfig.mdx @@ -7,11 +7,11 @@ title: "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, xAI). Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/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 | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum) | :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 xAI. Cannot be used with allowed_domains. | | | `MaxCharacters` | `*int64` | :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` | `*int64` | :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` | `*int64` | :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` | `*int64` | :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 | -| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/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` | [*components.WebSearchUserLocationServerTool](../../models/components/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"
} | \ No newline at end of file +| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel) | :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` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/websearchplugin.mdx b/docs/models/components/websearchplugin.mdx index 31f7616d..da843367 100644 --- a/docs/models/components/websearchplugin.mdx +++ b/docs/models/components/websearchplugin.mdx @@ -7,11 +7,11 @@ title: "WebSearchPlugin" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `Enabled` | `*bool` | :heavy_minus_sign: | Set to false to disable the web-search plugin for this request. Defaults to true. | | -| `Engine` | [*components.WebSearchEngine](../../models/components/websearchengine.mdx) | :heavy_minus_sign: | The search engine to use for web search. | exa | +| `Engine` | [*components.WebSearchEngine](../../models/components/websearchengine) | :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` | [components.WebSearchPluginID](../../models/components/websearchpluginid.mdx) | :heavy_check_mark: | N/A | | +| `ID` | [components.WebSearchPluginID](../../models/components/websearchpluginid) | :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` | `*int64` | :heavy_minus_sign: | N/A | | | `MaxUses` | `*int64` | :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). | | | `SearchPrompt` | `*string` | :heavy_minus_sign: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.UserLocation](../../models/components/userlocation.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 +| `UserLocation` | optionalnullable.OptionalNullable[[components.UserLocation](../../models/components/userlocation)] | :heavy_minus_sign: | 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/components/websearchservertool.mdx b/docs/models/components/websearchservertool.mdx index 721cd11a..cdebe47d 100644 --- a/docs/models/components/websearchservertool.mdx +++ b/docs/models/components/websearchservertool.mdx @@ -9,10 +9,10 @@ Web search tool configuration (2025-08-26 version) | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/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` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter.mdx)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum) | :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` | optionalnullable.OptionalNullable[[components.WebSearchDomainFilter](../../models/components/websearchdomainfilter)] | :heavy_minus_sign: | N/A | \{
"allowed_domains": [
"example.com"
],
"blocked_domains": [
"spam.com"
],
"excluded_domains": [
"spam.com"
]
} | | `MaxResults` | `*int64` | :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` | `*int64` | :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 | -| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum.mdx) | :heavy_minus_sign: | Size of the search context for web search tools | medium | -| `Type` | [components.WebSearchServerToolType](../../models/components/websearchservertooltype.mdx) | :heavy_check_mark: | N/A | | -| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation.mdx)] | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file +| `SearchContextSize` | [*components.SearchContextSizeEnum](../../models/components/searchcontextsizeenum) | :heavy_minus_sign: | Size of the search context for web search tools | medium | +| `Type` | [components.WebSearchServerToolType](../../models/components/websearchservertooltype) | :heavy_check_mark: | N/A | | +| `UserLocation` | optionalnullable.OptionalNullable[[components.WebSearchUserLocation](../../models/components/websearchuserlocation)] | :heavy_minus_sign: | User location information for web search | \{
"city": "San Francisco",
"country": "USA",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/websearchservertoolconfig.mdx b/docs/models/components/websearchservertoolconfig.mdx index af4aa57c..7160e08b 100644 --- a/docs/models/components/websearchservertoolconfig.mdx +++ b/docs/models/components/websearchservertoolconfig.mdx @@ -10,11 +10,11 @@ Configuration for the openrouter:web_search server tool | 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, xAI). Cannot be used with excluded_domains. | | -| `Engine` | [*components.WebSearchEngineEnum](../../models/components/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 | +| `Engine` | [*components.WebSearchEngineEnum](../../models/components/websearchengineenum) | :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 xAI. Cannot be used with allowed_domains. | | | `MaxCharacters` | `*int64` | :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` | `*int64` | :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` | `*int64` | :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` | `*int64` | :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 | -| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/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` | [*components.WebSearchUserLocationServerTool](../../models/components/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"
} | \ No newline at end of file +| `SearchContextSize` | [*components.SearchQualityLevel](../../models/components/searchqualitylevel) | :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` | [*components.WebSearchUserLocationServerTool](../../models/components/websearchuserlocationservertool) | :heavy_minus_sign: | Approximate user location for location-biased results. | \{
"city": "San Francisco",
"country": "US",
"region": "California",
"timezone": "America/Los_Angeles",
"type": "approximate"
} | \ No newline at end of file diff --git a/docs/models/components/websearchservertoolopenrouter.mdx b/docs/models/components/websearchservertoolopenrouter.mdx index 45b54e51..a840ad2c 100644 --- a/docs/models/components/websearchservertoolopenrouter.mdx +++ b/docs/models/components/websearchservertoolopenrouter.mdx @@ -9,5 +9,5 @@ OpenRouter built-in server tool: searches the web for current information | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Parameters` | [*components.WebSearchServerToolConfig](../../models/components/websearchservertoolconfig.mdx) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | -| `Type` | [components.WebSearchServerToolOpenRouterType](../../models/components/websearchservertoolopenroutertype.mdx) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `Parameters` | [*components.WebSearchServerToolConfig](../../models/components/websearchservertoolconfig) | :heavy_minus_sign: | Configuration for the openrouter:web_search server tool | \{
"max_results": 5,
"search_context_size": "medium"
} | +| `Type` | [components.WebSearchServerToolOpenRouterType](../../models/components/websearchservertoolopenroutertype) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/components/websearchsource.mdx b/docs/models/components/websearchsource.mdx index 395f5a3a..018209e2 100644 --- a/docs/models/components/websearchsource.mdx +++ b/docs/models/components/websearchsource.mdx @@ -6,5 +6,5 @@ title: "WebSearchSource" | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `Type` | [components.WebSearchSourceType](../../models/components/websearchsourcetype.mdx) | :heavy_check_mark: | N/A | +| `Type` | [components.WebSearchSourceType](../../models/components/websearchsourcetype) | :heavy_check_mark: | N/A | | `URL` | `string` | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchuserlocation.mdx b/docs/models/components/websearchuserlocation.mdx index 272b63c1..4bec9d88 100644 --- a/docs/models/components/websearchuserlocation.mdx +++ b/docs/models/components/websearchuserlocation.mdx @@ -13,4 +13,4 @@ User location information for web search | `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [*components.WebSearchUserLocationType](../../models/components/websearchuserlocationtype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | [*components.WebSearchUserLocationType](../../models/components/websearchuserlocationtype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/websearchuserlocationservertool.mdx b/docs/models/components/websearchuserlocationservertool.mdx index a1e0de9e..deb6e34b 100644 --- a/docs/models/components/websearchuserlocationservertool.mdx +++ b/docs/models/components/websearchuserlocationservertool.mdx @@ -13,4 +13,4 @@ Approximate user location for location-biased results. | `Country` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Region` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | | `Timezone` | optionalnullable.OptionalNullable[`string`] | :heavy_minus_sign: | N/A | -| `Type` | [*components.WebSearchUserLocationServerToolType](../../models/components/websearchuserlocationservertooltype.mdx) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `Type` | [*components.WebSearchUserLocationServerToolType](../../models/components/websearchuserlocationservertooltype) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/workspacebudget.mdx b/docs/models/components/workspacebudget.mdx index 07bb06ed..9ff161e4 100644 --- a/docs/models/components/workspacebudget.mdx +++ b/docs/models/components/workspacebudget.mdx @@ -9,6 +9,6 @@ title: "WorkspaceBudget" | `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` | `float64` | :heavy_check_mark: | Spending limit in USD for this interval | 100 | -| `ResetInterval` | [*components.ResetInterval](../../models/components/resetinterval.mdx) | :heavy_check_mark: | Interval at which spend resets. Null means a lifetime (one-time) budget. | monthly | +| `ResetInterval` | [*components.ResetInterval](../../models/components/resetinterval) | :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 diff --git a/docs/models/components/workspacemember.mdx b/docs/models/components/workspacemember.mdx index 1dcdc0b0..e88f682f 100644 --- a/docs/models/components/workspacemember.mdx +++ b/docs/models/components/workspacemember.mdx @@ -8,6 +8,6 @@ title: "WorkspaceMember" | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `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` | [components.WorkspaceMemberRole](../../models/components/workspacememberrole.mdx) | :heavy_check_mark: | Role of the member in the workspace | member | +| `Role` | [components.WorkspaceMemberRole](../../models/components/workspacememberrole) | :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 diff --git a/docs/models/operations/bulkaddworkspacemembersrequest.mdx b/docs/models/operations/bulkaddworkspacemembersrequest.mdx index c33d12a5..f94add81 100644 --- a/docs/models/operations/bulkaddworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkaddworkspacemembersrequest.mdx @@ -7,4 +7,4 @@ title: "BulkAddWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `BulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `BulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx index 664f4909..827d2eb2 100644 --- a/docs/models/operations/bulkassignkeystoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignkeystoguardrailrequest.mdx @@ -7,4 +7,4 @@ title: "BulkAssignKeysToGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `BulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx index fcaab1b7..975ac9a7 100644 --- a/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx +++ b/docs/models/operations/bulkassignmemberstoguardrailrequest.mdx @@ -7,4 +7,4 @@ title: "BulkAssignMembersToGuardrailRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `BulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx index 1333a3b4..2784d3e3 100644 --- a/docs/models/operations/bulkremoveworkspacemembersrequest.mdx +++ b/docs/models/operations/bulkremoveworkspacemembersrequest.mdx @@ -7,4 +7,4 @@ title: "BulkRemoveWorkspaceMembersRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `BulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `BulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx index bc3a865a..aad3f399 100644 --- a/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignkeysfromguardrailrequest.mdx @@ -7,4 +7,4 @@ title: "BulkUnassignKeysFromGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file +| `BulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | \ No newline at end of file diff --git a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx index 39f2fbf6..9e3e051d 100644 --- a/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx +++ b/docs/models/operations/bulkunassignmembersfromguardrailrequest.mdx @@ -7,4 +7,4 @@ title: "BulkUnassignMembersFromGuardrailRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `BulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file +| `BulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | \ No newline at end of file diff --git a/docs/models/operations/classifierfilters.mdx b/docs/models/operations/classifierfilters.mdx index 27444c7e..33866f62 100644 --- a/docs/models/operations/classifierfilters.mdx +++ b/docs/models/operations/classifierfilters.mdx @@ -10,4 +10,4 @@ Filter results to generations with specific classifier tag values. Can be combin | 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 +| `Filters` | [][operations.ClassifierFiltersFilter](../../models/operations/classifierfiltersfilter) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/classifierfiltersfilter.mdx b/docs/models/operations/classifierfiltersfilter.mdx index 3e1d7650..6c3614f6 100644 --- a/docs/models/operations/classifierfiltersfilter.mdx +++ b/docs/models/operations/classifierfiltersfilter.mdx @@ -8,4 +8,4 @@ title: "ClassifierFiltersFilter" | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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](../../models/operations/classifierfiltersvalue.mdx) | :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 +| `Value` | [operations.ClassifierFiltersValue](../../models/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 diff --git a/docs/models/operations/contentimageurl.mdx b/docs/models/operations/contentimageurl.mdx index 316466dd..12e0cfbf 100644 --- a/docs/models/operations/contentimageurl.mdx +++ b/docs/models/operations/contentimageurl.mdx @@ -6,5 +6,5 @@ title: "ContentImageURL" | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `ImageURL` | [operations.ImageURL](../../models/operations/imageurl.mdx) | :heavy_check_mark: | N/A | -| `Type` | [operations.TypeImageURL](../../models/operations/typeimageurl.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `ImageURL` | [operations.ImageURL](../../models/operations/imageurl) | :heavy_check_mark: | N/A | +| `Type` | [operations.TypeImageURL](../../models/operations/typeimageurl) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/contenttext.mdx b/docs/models/operations/contenttext.mdx index f9a90d0b..5be1433d 100644 --- a/docs/models/operations/contenttext.mdx +++ b/docs/models/operations/contenttext.mdx @@ -7,4 +7,4 @@ title: "ContentText" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | | `Text` | `string` | :heavy_check_mark: | N/A | -| `Type` | [operations.TypeText](../../models/operations/typetext.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Type` | [operations.TypeText](../../models/operations/typetext) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx index 520e5a3f..84846bab 100644 --- a/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx +++ b/docs/models/operations/createaudiotranscriptionsmultipartrequest.mdx @@ -6,9 +6,9 @@ title: "CreateAudioTranscriptionsMultipartRequest" | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `File` | [operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile.mdx) | :heavy_check_mark: | 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. | +| `File` | [operations.CreateAudioTranscriptionsMultipartFile](../../models/operations/createaudiotranscriptionsmultipartfile) | :heavy_check_mark: | 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. | | `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. | -| `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). | +| `ResponseFormat` | [*operations.ResponseFormat](../../models/operations/responseformat) | :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). | | `Temperature` | `*float64` | :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. | \ No newline at end of file +| `TimestampGranularities` | [][operations.TimestampGranularities](../../models/operations/timestampgranularities) | :heavy_minus_sign: | Timestamp detail levels to include when response_format is "verbose_json". "word" additionally returns word-level timestamps in the words array. | \ No newline at end of file diff --git a/docs/models/operations/createauthkeyscoderequest.mdx b/docs/models/operations/createauthkeyscoderequest.mdx index 1cef604b..98dcae6d 100644 --- a/docs/models/operations/createauthkeyscoderequest.mdx +++ b/docs/models/operations/createauthkeyscoderequest.mdx @@ -8,9 +8,9 @@ title: "CreateAuthKeysCodeRequest" | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `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 | +| `CodeChallengeMethod` | [*operations.CreateAuthKeysCodeCodeChallengeMethod](../../models/operations/createauthkeyscodecodechallengemethod) | :heavy_minus_sign: | The method used to generate the code challenge | S256 | | `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | Optional expiration time for the API key to be created | 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` | `*float64` | :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 | +| `UsageLimitType` | [*operations.UsageLimitType](../../models/operations/usagelimittype) | :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 diff --git a/docs/models/operations/createauthkeyscoderesponse.mdx b/docs/models/operations/createauthkeyscoderesponse.mdx index 90fd1b3f..ce62ac13 100644 --- a/docs/models/operations/createauthkeyscoderesponse.mdx +++ b/docs/models/operations/createauthkeyscoderesponse.mdx @@ -9,4 +9,4 @@ Successfully created authorization code | 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) | :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 diff --git a/docs/models/operations/createembeddingsdata.mdx b/docs/models/operations/createembeddingsdata.mdx index 297e417a..dbbcaaaf 100644 --- a/docs/models/operations/createembeddingsdata.mdx +++ b/docs/models/operations/createembeddingsdata.mdx @@ -9,6 +9,6 @@ A single embedding object | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Embedding` | [operations.Embedding](../../models/operations/embedding.mdx) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | +| `Embedding` | [operations.Embedding](../../models/operations/embedding) | :heavy_check_mark: | Embedding vector as an array of floats or a base64 string | [
0.0023064255,
-0.009327292,
0.015797347
] | | `Index` | `*int64` | :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 +| `Object` | [operations.ObjectEmbedding](../../models/operations/objectembedding) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/createembeddingsrequest.mdx b/docs/models/operations/createembeddingsrequest.mdx index 7d2d679f..1ff3ca31 100644 --- a/docs/models/operations/createembeddingsrequest.mdx +++ b/docs/models/operations/createembeddingsrequest.mdx @@ -10,9 +10,9 @@ Embeddings request input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `Dimensions` | `*int64` | :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](../../models/operations/inputunion.mdx) | :heavy_check_mark: | Text, token, or multimodal input(s) to embed | The quick brown fox jumps over the lazy dog | +| `EncodingFormat` | [*operations.EncodingFormat](../../models/operations/encodingformat) | :heavy_minus_sign: | The format of the output embeddings | float | +| `Input` | [operations.InputUnion](../../models/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` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences)] | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | | `User` | `*string` | :heavy_minus_sign: | 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 321bb0f0..61c851e4 100644 --- a/docs/models/operations/createembeddingsresponsebody.mdx +++ b/docs/models/operations/createembeddingsresponsebody.mdx @@ -9,8 +9,8 @@ Embeddings response containing embedding vectors | 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"
}
] | +| `Data` | [][operations.CreateEmbeddingsData](../../models/operations/createembeddingsdata) | :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.Object](../../models/operations/object.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 +| `Object` | [operations.Object](../../models/operations/object) | :heavy_check_mark: | N/A | | +| `Usage` | [*operations.CreateEmbeddingsUsage](../../models/operations/createembeddingsusage) | :heavy_minus_sign: | 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 830d748c..72382704 100644 --- a/docs/models/operations/createembeddingsusage.mdx +++ b/docs/models/operations/createembeddingsusage.mdx @@ -10,8 +10,8 @@ Token usage statistics | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Cost` | `*float64` | :heavy_minus_sign: | Cost of the request in credits | 0.0001 | -| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/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
} | +| `CostDetails` | optionalnullable.OptionalNullable[[components.CostDetails](../../models/components/costdetails)] | :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` | `*bool` | :heavy_minus_sign: | Whether a request was made using a Bring Your Own Key configuration | | | `PromptTokens` | `int64` | :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. | | +| `PromptTokensDetails` | [*operations.PromptTokensDetails](../../models/operations/prompttokensdetails) | :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` | `int64` | :heavy_check_mark: | Total number of tokens used | 8 | \ No newline at end of file diff --git a/docs/models/operations/createkeysrequest.mdx b/docs/models/operations/createkeysrequest.mdx index bc92890e..425b5b59 100644 --- a/docs/models/operations/createkeysrequest.mdx +++ b/docs/models/operations/createkeysrequest.mdx @@ -10,6 +10,6 @@ title: "CreateKeysRequest" | `ExpiresAt` | optionalnullable.OptionalNullable[[time.Time](https://pkg.go.dev/time#Time)] | :heavy_minus_sign: | Optional ISO 8601 UTC timestamp when the API key should expire. Must be UTC, other timezones will be rejected | 2027-12-31T23:59:59Z | | `IncludeByokInLimit` | `*bool` | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | | `Limit` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Optional spending limit for the API key in USD | 50 | -| `LimitReset` | optionalnullable.OptionalNullable[[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 | +| `LimitReset` | optionalnullable.OptionalNullable[[operations.CreateKeysLimitReset](../../models/operations/createkeyslimitreset)] | :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 diff --git a/docs/models/operations/createkeysresponse.mdx b/docs/models/operations/createkeysresponse.mdx index 6d24dcf3..402979b4 100644 --- a/docs/models/operations/createkeysresponse.mdx +++ b/docs/models/operations/createkeysresponse.mdx @@ -9,5 +9,5 @@ API key created successfully | 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",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"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"
} | +| `Data` | [operations.CreateKeysData](../../models/operations/createkeysdata) | :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",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"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 diff --git a/docs/models/operations/createpresetschatcompletionsrequest.mdx b/docs/models/operations/createpresetschatcompletionsrequest.mdx index 1d0cf03a..a9893431 100644 --- a/docs/models/operations/createpresetschatcompletionsrequest.mdx +++ b/docs/models/operations/createpresetschatcompletionsrequest.mdx @@ -7,4 +7,4 @@ title: "CreatePresetsChatCompletionsRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `ChatRequest` | [components.ChatRequest](../../models/components/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 +| `ChatRequest` | [components.ChatRequest](../../models/components/chatrequest) | :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 diff --git a/docs/models/operations/createpresetsmessagesrequest.mdx b/docs/models/operations/createpresetsmessagesrequest.mdx index 30d1a19b..90ce7b52 100644 --- a/docs/models/operations/createpresetsmessagesrequest.mdx +++ b/docs/models/operations/createpresetsmessagesrequest.mdx @@ -7,4 +7,4 @@ title: "CreatePresetsMessagesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `MessagesRequest` | [components.MessagesRequest](../../models/components/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 +| `MessagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest) | :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 diff --git a/docs/models/operations/createpresetsresponsesrequest.mdx b/docs/models/operations/createpresetsresponsesrequest.mdx index 6bb668f9..7fbca5dc 100644 --- a/docs/models/operations/createpresetsresponsesrequest.mdx +++ b/docs/models/operations/createpresetsresponsesrequest.mdx @@ -7,4 +7,4 @@ title: "CreatePresetsResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/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 +| `ResponsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest) | :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 diff --git a/docs/models/operations/creatererankrequest.mdx b/docs/models/operations/creatererankrequest.mdx index 64951413..90fdc1b8 100644 --- a/docs/models/operations/creatererankrequest.mdx +++ b/docs/models/operations/creatererankrequest.mdx @@ -9,8 +9,8 @@ Rerank request input | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `Documents` | [][operations.Document](../../models/operations/document.mdx) | :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."
] | +| `Documents` | [][operations.Document](../../models/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` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences.mdx)] | :heavy_minus_sign: | N/A | \{
"allow_fallbacks": true
} | +| `Provider` | optionalnullable.OptionalNullable[[components.ProviderPreferences](../../models/components/providerpreferences)] | :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? | | `TopN` | `*int64` | :heavy_minus_sign: | Number of most relevant documents to return | 3 | \ No newline at end of file diff --git a/docs/models/operations/creatererankresponsebody.mdx b/docs/models/operations/creatererankresponsebody.mdx index d9d8a5db..2c53200c 100644 --- a/docs/models/operations/creatererankresponsebody.mdx +++ b/docs/models/operations/creatererankresponsebody.mdx @@ -12,5 +12,5 @@ Rerank response containing ranked results | `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 +| `Results` | [][operations.Result](../../models/operations/result) | :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) | :heavy_minus_sign: | Usage statistics | \{
"search_units": 1,
"total_tokens": 150
} | \ No newline at end of file diff --git a/docs/models/operations/createresponsesrequest.mdx b/docs/models/operations/createresponsesrequest.mdx index 3af4a416..242e58ce 100644 --- a/docs/models/operations/createresponsesrequest.mdx +++ b/docs/models/operations/createresponsesrequest.mdx @@ -6,5 +6,5 @@ title: "CreateResponsesRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/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` | [components.ResponsesRequest](../../models/components/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 +| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel) | :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` | [components.ResponsesRequest](../../models/components/responsesrequest) | :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 diff --git a/docs/models/operations/deletefilerequest.mdx b/docs/models/operations/deletefilerequest.mdx index 1167b1c0..0da3b09f 100644 --- a/docs/models/operations/deletefilerequest.mdx +++ b/docs/models/operations/deletefilerequest.mdx @@ -8,4 +8,4 @@ title: "DeleteFileRequest" | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `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` | [*components.FileProvider](../../models/components/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 +| `Provider` | [*components.FileProvider](../../models/components/fileprovider) | :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 diff --git a/docs/models/operations/deleteworkspacebudgetrequest.mdx b/docs/models/operations/deleteworkspacebudgetrequest.mdx index b7e6148c..131f62d1 100644 --- a/docs/models/operations/deleteworkspacebudgetrequest.mdx +++ b/docs/models/operations/deleteworkspacebudgetrequest.mdx @@ -7,4 +7,4 @@ title: "DeleteWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/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 +| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval) | :heavy_check_mark: | 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/downloadfilecontentrequest.mdx b/docs/models/operations/downloadfilecontentrequest.mdx index 6f311f37..34faa195 100644 --- a/docs/models/operations/downloadfilecontentrequest.mdx +++ b/docs/models/operations/downloadfilecontentrequest.mdx @@ -8,4 +8,4 @@ title: "DownloadFileContentRequest" | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `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` | [*components.FileProvider](../../models/components/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 +| `Provider` | [*components.FileProvider](../../models/components/fileprovider) | :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 diff --git a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx index 728bab69..407c112e 100644 --- a/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx +++ b/docs/models/operations/exchangeauthcodeforapikeyrequest.mdx @@ -7,5 +7,5 @@ title: "ExchangeAuthCodeForAPIKeyRequest" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Code` | `string` | :heavy_check_mark: | The authorization code received from the OAuth redirect | auth_code_abc123def456 | -| `CodeChallengeMethod` | optionalnullable.OptionalNullable[[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod.mdx)] | :heavy_minus_sign: | The method used to generate the code challenge | S256 | +| `CodeChallengeMethod` | optionalnullable.OptionalNullable[[operations.ExchangeAuthCodeForAPIKeyCodeChallengeMethod](../../models/operations/exchangeauthcodeforapikeycodechallengemethod)] | :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 diff --git a/docs/models/operations/filter.mdx b/docs/models/operations/filter.mdx index 6b4516c9..5d92629f 100644 --- a/docs/models/operations/filter.mdx +++ b/docs/models/operations/filter.mdx @@ -8,4 +8,4 @@ title: "Filter" | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Field` | `string` | :heavy_check_mark: | Dimension to filter on. Use the /meta endpoint for available dimensions. | model | | `Operator` | `string` | :heavy_check_mark: | Filter operator | eq | -| `Value` | [operations.Value1](../../models/operations/value1.mdx) | :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; `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 +| `Value` | [operations.Value1](../../models/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; `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 d984d60e..d1d3fd86 100644 --- a/docs/models/operations/getanalyticsmetadata.mdx +++ b/docs/models/operations/getanalyticsmetadata.mdx @@ -6,7 +6,7 @@ title: "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) | :heavy_check_mark: | N/A | +| `Granularities` | [][operations.Granularity](../../models/operations/granularity) | :heavy_check_mark: | N/A | +| `Metrics` | [][operations.Metric](../../models/operations/metric) | :heavy_check_mark: | N/A | +| `Operators` | [][operations.Operator](../../models/operations/operator) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getanalyticsmetaresponse.mdx b/docs/models/operations/getanalyticsmetaresponse.mdx index 3c59f354..b5e7c083 100644 --- a/docs/models/operations/getanalyticsmetaresponse.mdx +++ b/docs/models/operations/getanalyticsmetaresponse.mdx @@ -9,4 +9,4 @@ Returns analytics query metadata | 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) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/getapprankingsrequest.mdx b/docs/models/operations/getapprankingsrequest.mdx index 062c2050..053215b4 100644 --- a/docs/models/operations/getapprankingsrequest.mdx +++ b/docs/models/operations/getapprankingsrequest.mdx @@ -6,9 +6,9 @@ title: "GetAppRankingsRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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 | +| `Category` | [*operations.GetAppRankingsCategory](../../models/operations/getapprankingscategory) | :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) | :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) | :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` | `*int64` | :heavy_minus_sign: | Maximum number of apps to return (1-100). Defaults to 50. | 50 | diff --git a/docs/models/operations/getapprankingsresponse.mdx b/docs/models/operations/getapprankingsresponse.mdx index ff7961b5..e5ccd5a8 100644 --- a/docs/models/operations/getapprankingsresponse.mdx +++ b/docs/models/operations/getapprankingsresponse.mdx @@ -6,4 +6,4 @@ title: "GetAppRankingsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.AppRankingsResponse](../../models/components/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:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file +| `Result` | [components.AppRankingsResponse](../../models/components/apprankingsresponse) | :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:00Z",
"end_date": "2026-05-11",
"start_date": "2026-04-12",
"version": "v1"
}
} | \ No newline at end of file diff --git a/docs/models/operations/getbenchmarksrequest.mdx b/docs/models/operations/getbenchmarksrequest.mdx index b6405ca3..e9752b14 100644 --- a/docs/models/operations/getbenchmarksrequest.mdx +++ b/docs/models/operations/getbenchmarksrequest.mdx @@ -6,8 +6,8 @@ title: "GetBenchmarksRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | coding | -| `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 | +| `Source` | [*operations.Source](../../models/operations/source) | :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) | :heavy_minus_sign: | Filter results by task type. For Artificial Analysis, maps to the corresponding index. For Design Arena, maps to the matching category. | coding | +| `Arena` | [*operations.Arena](../../models/operations/arena) | :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` | `*int64` | :heavy_minus_sign: | 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/getcreditsresponse.mdx b/docs/models/operations/getcreditsresponse.mdx index 11dc4d56..46b1c25e 100644 --- a/docs/models/operations/getcreditsresponse.mdx +++ b/docs/models/operations/getcreditsresponse.mdx @@ -9,4 +9,4 @@ Total credits purchased and used | 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) | :heavy_check_mark: | 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 31165ce4..daa43688 100644 --- a/docs/models/operations/getcurrentkeydata.mdx +++ b/docs/models/operations/getcurrentkeydata.mdx @@ -23,7 +23,7 @@ Current API key information | `Limit` | `*float64` | :heavy_check_mark: | Spending limit for the API key in USD | 100 | | `LimitRemaining` | `*float64` | :heavy_check_mark: | Remaining spending limit in USD | 74.5 | | `LimitReset` | `*string` | :heavy_check_mark: | Type of limit reset for the API key | monthly | -| ~~`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
} | +| ~~`RateLimit`~~ | [operations.RateLimit](../../models/operations/ratelimit) | :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` | `float64` | :heavy_check_mark: | Total OpenRouter credit usage (in USD) for the API key | 25.5 | | `UsageDaily` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC day | 25.5 | | `UsageMonthly` | `float64` | :heavy_check_mark: | OpenRouter credit usage (in USD) for the current UTC month | 25.5 | diff --git a/docs/models/operations/getcurrentkeyresponse.mdx b/docs/models/operations/getcurrentkeyresponse.mdx index 95054719..c4358c21 100644 --- a/docs/models/operations/getcurrentkeyresponse.mdx +++ b/docs/models/operations/getcurrentkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [operations.GetCurrentKeyData](../../models/operations/getcurrentkeydata.mdx) | :heavy_check_mark: | Current API key information | \{
"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",
"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) | :heavy_check_mark: | Current API key information | \{
"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",
"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/getfilemetadatarequest.mdx b/docs/models/operations/getfilemetadatarequest.mdx index f75dd849..6c898b5b 100644 --- a/docs/models/operations/getfilemetadatarequest.mdx +++ b/docs/models/operations/getfilemetadatarequest.mdx @@ -8,4 +8,4 @@ title: "GetFileMetadataRequest" | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `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` | [*components.FileProvider](../../models/components/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 +| `Provider` | [*components.FileProvider](../../models/components/fileprovider) | :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 diff --git a/docs/models/operations/getkeyresponse.mdx b/docs/models/operations/getkeyresponse.mdx index 839c4b46..c68bee5f 100644 --- a/docs/models/operations/getkeyresponse.mdx +++ b/docs/models/operations/getkeyresponse.mdx @@ -9,4 +9,4 @@ API key details | 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",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"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) | :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",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"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/getmodelsrequest.mdx b/docs/models/operations/getmodelsrequest.mdx index 5a6b2463..5394bcc6 100644 --- a/docs/models/operations/getmodelsrequest.mdx +++ b/docs/models/operations/getmodelsrequest.mdx @@ -8,10 +8,10 @@ title: "GetModelsRequest" | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | | `Limit` | `*int64` | :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 | +| `Category` | [*operations.GetModelsCategory](../../models/operations/getmodelscategory) | :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, audio, embeddings) 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 | +| `Sort` | [*operations.GetModelsSort](../../models/operations/getmodelssort) | :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` | `*int64` | :heavy_minus_sign: | Minimum context length (tokens). Models with smaller context are excluded. | 128000 | @@ -20,9 +20,9 @@ title: "GetModelsRequest" | `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. Currently only "eu" is supported. | eu | +| `Distillable` | [*operations.Distillable](../../models/operations/distillable) | :heavy_minus_sign: | Filter by distillation capability. "true" returns only distillable models, "false" excludes them. | true | +| `Zdr` | [*operations.Zdr](../../models/operations/zdr) | :heavy_minus_sign: | When set to "true", return only models with zero data retention endpoints. | true | +| `Region` | [*operations.Region](../../models/operations/region) | :heavy_minus_sign: | Filter to models with endpoints in the given data region. Currently only "eu" is supported. | eu | | `MinOutputPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Minimum completion (output) price in $/M tokens. | 0 | | `MaxOutputPrice` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | Maximum completion (output) price in $/M tokens. | 10 | | `MinAgeDays` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Minimum model age in days since its creation date. | 0 | diff --git a/docs/models/operations/getmodelsresponse.mdx b/docs/models/operations/getmodelsresponse.mdx index dc7254dd..75d309ce 100644 --- a/docs/models/operations/getmodelsresponse.mdx +++ b/docs/models/operations/getmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "GetModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ModelsListResponse](../../models/components/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` | [components.ModelsListResponse](../../models/components/modelslistresponse) | :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 diff --git a/docs/models/operations/getrankingsdailyrequest.mdx b/docs/models/operations/getrankingsdailyrequest.mdx index 45ad0883..695ff3a8 100644 --- a/docs/models/operations/getrankingsdailyrequest.mdx +++ b/docs/models/operations/getrankingsdailyrequest.mdx @@ -8,8 +8,8 @@ title: "GetRankingsDailyRequest" | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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 +| `Period` | [*operations.Period](../../models/operations/period) | :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) | :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) | :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) | :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) | :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 diff --git a/docs/models/operations/gettaskclassificationsrequest.mdx b/docs/models/operations/gettaskclassificationsrequest.mdx index a80174e6..2c20a920 100644 --- a/docs/models/operations/gettaskclassificationsrequest.mdx +++ b/docs/models/operations/gettaskclassificationsrequest.mdx @@ -6,4 +6,4 @@ title: "GetTaskClassificationsRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `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 +| `Window` | [*operations.Window](../../models/operations/window) | :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 diff --git a/docs/models/operations/granularity.mdx b/docs/models/operations/granularity.mdx index e63f71fa..ae58286c 100644 --- a/docs/models/operations/granularity.mdx +++ b/docs/models/operations/granularity.mdx @@ -7,4 +7,4 @@ title: "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 +| `Name` | [operations.GranularityName](../../models/operations/granularityname) | :heavy_check_mark: | Granularity identifier | day | \ No newline at end of file diff --git a/docs/models/operations/input.mdx b/docs/models/operations/input.mdx index 560e8b39..28a9b46c 100644 --- a/docs/models/operations/input.mdx +++ b/docs/models/operations/input.mdx @@ -6,4 +6,4 @@ title: "Input" | Field | Type | Required | Description | | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `Content` | [][operations.Content](../../models/operations/content.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Content` | [][operations.Content](../../models/operations/content) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listbyokkeysrequest.mdx b/docs/models/operations/listbyokkeysrequest.mdx index 7f13a35f..ac119d93 100644 --- a/docs/models/operations/listbyokkeysrequest.mdx +++ b/docs/models/operations/listbyokkeysrequest.mdx @@ -9,4 +9,4 @@ title: "ListBYOKKeysRequest" | `Offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `Limit` | `*int64` | :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 | -| `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 +| `Provider` | [*operations.Provider](../../models/operations/provider) | :heavy_minus_sign: | 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 8af15926..4d3304f0 100644 --- a/docs/models/operations/listbyokkeysresponse.mdx +++ b/docs/models/operations/listbyokkeysresponse.mdx @@ -6,4 +6,4 @@ title: "ListBYOKKeysResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListBYOKKeysResponse](../../models/components/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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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` | [components.ListBYOKKeysResponse](../../models/components/listbyokkeysresponse) | :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",
"disabled": false,
"id": "11111111-2222-3333-4444-555555555555",
"is_fallback": 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/listembeddingsmodelsresponse.mdx b/docs/models/operations/listembeddingsmodelsresponse.mdx index 2512a3f5..225805f7 100644 --- a/docs/models/operations/listembeddingsmodelsresponse.mdx +++ b/docs/models/operations/listembeddingsmodelsresponse.mdx @@ -6,4 +6,4 @@ title: "ListEmbeddingsModelsResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ModelsListResponse](../../models/components/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` | [components.ModelsListResponse](../../models/components/modelslistresponse) | :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 diff --git a/docs/models/operations/listendpointsresponse.mdx b/docs/models/operations/listendpointsresponse.mdx index 8f62ed5f..696dce77 100644 --- a/docs/models/operations/listendpointsresponse.mdx +++ b/docs/models/operations/listendpointsresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Data` | [components.ListEndpointsResponse](../../models/components/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` | [components.ListEndpointsResponse](../../models/components/listendpointsresponse) | :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 diff --git a/docs/models/operations/listendpointszdrresponse.mdx b/docs/models/operations/listendpointszdrresponse.mdx index 3aed99b5..7e14f0db 100644 --- a/docs/models/operations/listendpointszdrresponse.mdx +++ b/docs/models/operations/listendpointszdrresponse.mdx @@ -9,4 +9,4 @@ Returns a list of endpoints | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `Data` | [][components.PublicEndpoint](../../models/components/publicendpoint.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `Data` | [][components.PublicEndpoint](../../models/components/publicendpoint) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listfilesrequest.mdx b/docs/models/operations/listfilesrequest.mdx index b4ae6e39..0f254a6b 100644 --- a/docs/models/operations/listfilesrequest.mdx +++ b/docs/models/operations/listfilesrequest.mdx @@ -9,8 +9,8 @@ title: "ListFilesRequest" | `Limit` | `*int64` | :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` | [*components.FileProvider](../../models/components/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 | +| `Provider` | [*components.FileProvider](../../models/components/fileprovider) | :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 +| `Order` | [*operations.Order](../../models/operations/order) | :heavy_minus_sign: | 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 eae01171..b08b0985 100644 --- a/docs/models/operations/listfilesresponse.mdx +++ b/docs/models/operations/listfilesresponse.mdx @@ -6,4 +6,4 @@ title: "ListFilesResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.FileListResponse](../../models/components/filelistresponse.mdx) | :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` | [components.FileListResponse](../../models/components/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 diff --git a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx index b1a2c2e2..0e7401ac 100644 --- a/docs/models/operations/listguardrailkeyassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/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` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse) | :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 diff --git a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx index ee830a1c..29c443fa 100644 --- a/docs/models/operations/listguardrailmemberassignmentsresponse.mdx +++ b/docs/models/operations/listguardrailmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/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` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse) | :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 diff --git a/docs/models/operations/listguardrailsresponse.mdx b/docs/models/operations/listguardrailsresponse.mdx index 432dfaf0..23e25b8b 100644 --- a/docs/models/operations/listguardrailsresponse.mdx +++ b/docs/models/operations/listguardrailsresponse.mdx @@ -6,4 +6,4 @@ title: "ListGuardrailsResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListGuardrailsResponse](../../models/components/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",
"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` | [components.ListGuardrailsResponse](../../models/components/listguardrailsresponse) | :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",
"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/listkeyassignmentsresponse.mdx b/docs/models/operations/listkeyassignmentsresponse.mdx index 02bce345..33e092d1 100644 --- a/docs/models/operations/listkeyassignmentsresponse.mdx +++ b/docs/models/operations/listkeyassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListKeyAssignmentsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListKeyAssignmentsResponse](../../models/components/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` | [components.ListKeyAssignmentsResponse](../../models/components/listkeyassignmentsresponse) | :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 diff --git a/docs/models/operations/listmemberassignmentsresponse.mdx b/docs/models/operations/listmemberassignmentsresponse.mdx index f1ab2400..b88f3c25 100644 --- a/docs/models/operations/listmemberassignmentsresponse.mdx +++ b/docs/models/operations/listmemberassignmentsresponse.mdx @@ -6,4 +6,4 @@ title: "ListMemberAssignmentsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListMemberAssignmentsResponse](../../models/components/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` | [components.ListMemberAssignmentsResponse](../../models/components/listmemberassignmentsresponse) | :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 diff --git a/docs/models/operations/listmodelsuserresponse.mdx b/docs/models/operations/listmodelsuserresponse.mdx index 2efd1749..db1d0dcc 100644 --- a/docs/models/operations/listmodelsuserresponse.mdx +++ b/docs/models/operations/listmodelsuserresponse.mdx @@ -6,4 +6,4 @@ title: "ListModelsUserResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ModelsListResponse](../../models/components/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` | [components.ModelsListResponse](../../models/components/modelslistresponse) | :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 diff --git a/docs/models/operations/listobservabilitydestinationsresponse.mdx b/docs/models/operations/listobservabilitydestinationsresponse.mdx index f8d6a27e..26c9e94c 100644 --- a/docs/models/operations/listobservabilitydestinationsresponse.mdx +++ b/docs/models/operations/listobservabilitydestinationsresponse.mdx @@ -6,4 +6,4 @@ title: "ListObservabilityDestinationsResponse" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListObservabilityDestinationsResponse](../../models/components/listobservabilitydestinationsresponse.mdx) | :heavy_check_mark: | N/A | \{
"data": [
\{
"api_key_hashes": null,
"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,
"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` | [components.ListObservabilityDestinationsResponse](../../models/components/listobservabilitydestinationsresponse) | :heavy_check_mark: | N/A | \{
"data": [
\{
"api_key_hashes": null,
"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,
"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 9f22477b..ad3917ed 100644 --- a/docs/models/operations/listorganizationmembersdata.mdx +++ b/docs/models/operations/listorganizationmembersdata.mdx @@ -10,4 +10,4 @@ title: "ListOrganizationMembersData" | `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 +| `Role` | [operations.Role](../../models/operations/role) | :heavy_check_mark: | Role of the member in the organization | org:member | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponse.mdx b/docs/models/operations/listorganizationmembersresponse.mdx index 0dd53b74..11b5a153 100644 --- a/docs/models/operations/listorganizationmembersresponse.mdx +++ b/docs/models/operations/listorganizationmembersresponse.mdx @@ -6,4 +6,4 @@ title: "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) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listorganizationmembersresponsebody.mdx b/docs/models/operations/listorganizationmembersresponsebody.mdx index 89160146..74e575c7 100644 --- a/docs/models/operations/listorganizationmembersresponsebody.mdx +++ b/docs/models/operations/listorganizationmembersresponsebody.mdx @@ -9,5 +9,5 @@ List of organization members | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `Data` | [][operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata.mdx) | :heavy_check_mark: | List of organization members | | +| `Data` | [][operations.ListOrganizationMembersData](../../models/operations/listorganizationmembersdata) | :heavy_check_mark: | List of organization members | | | `TotalCount` | `int64` | :heavy_check_mark: | Total number of members in the organization | 25 | \ No newline at end of file diff --git a/docs/models/operations/listpresetsresponse.mdx b/docs/models/operations/listpresetsresponse.mdx index b2f448b8..8be6cd88 100644 --- a/docs/models/operations/listpresetsresponse.mdx +++ b/docs/models/operations/listpresetsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.ListPresetsResponse](../../models/components/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` | [components.ListPresetsResponse](../../models/components/listpresetsresponse) | :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 diff --git a/docs/models/operations/listpresetversionsresponse.mdx b/docs/models/operations/listpresetversionsresponse.mdx index 1e9724a3..569046d5 100644 --- a/docs/models/operations/listpresetversionsresponse.mdx +++ b/docs/models/operations/listpresetversionsresponse.mdx @@ -6,4 +6,4 @@ title: "ListPresetVersionsResponse" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Result` | [components.ListPresetVersionsResponse](../../models/components/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` | [components.ListPresetVersionsResponse](../../models/components/listpresetversionsresponse) | :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 diff --git a/docs/models/operations/listprovidersdata.mdx b/docs/models/operations/listprovidersdata.mdx index d3a2945a..0fbe9216 100644 --- a/docs/models/operations/listprovidersdata.mdx +++ b/docs/models/operations/listprovidersdata.mdx @@ -6,8 +6,8 @@ title: "ListProvidersData" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `Datacenters` | optionalnullable.OptionalNullable[[][operations.Datacenter](../../models/operations/datacenter.mdx)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | -| `Headquarters` | optionalnullable.OptionalNullable[[operations.Headquarters](../../models/operations/headquarters.mdx)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country code of the provider headquarters | US | +| `Datacenters` | optionalnullable.OptionalNullable[[][operations.Datacenter](../../models/operations/datacenter)] | :heavy_minus_sign: | ISO 3166-1 Alpha-2 country codes of the provider datacenter locations | [
"US",
"IE"
] | +| `Headquarters` | optionalnullable.OptionalNullable[[operations.Headquarters](../../models/operations/headquarters)] | :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 | diff --git a/docs/models/operations/listprovidersresponse.mdx b/docs/models/operations/listprovidersresponse.mdx index d691c601..165e474c 100644 --- a/docs/models/operations/listprovidersresponse.mdx +++ b/docs/models/operations/listprovidersresponse.mdx @@ -9,4 +9,4 @@ Returns a list of providers | 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) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/listresponse.mdx b/docs/models/operations/listresponse.mdx index 43ab0b4e..997ba1ba 100644 --- a/docs/models/operations/listresponse.mdx +++ b/docs/models/operations/listresponse.mdx @@ -9,4 +9,4 @@ List of API keys | 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) | :heavy_check_mark: | List of API keys | \ No newline at end of file diff --git a/docs/models/operations/listworkspacemembersresponse.mdx b/docs/models/operations/listworkspacemembersresponse.mdx index 6aea6b68..55cc6738 100644 --- a/docs/models/operations/listworkspacemembersresponse.mdx +++ b/docs/models/operations/listworkspacemembersresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspaceMembersResponse" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListWorkspaceMembersResponse](../../models/components/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` | [components.ListWorkspaceMembersResponse](../../models/components/listworkspacemembersresponse) | :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 diff --git a/docs/models/operations/listworkspacesresponse.mdx b/docs/models/operations/listworkspacesresponse.mdx index 6255730f..cd7af8f1 100644 --- a/docs/models/operations/listworkspacesresponse.mdx +++ b/docs/models/operations/listworkspacesresponse.mdx @@ -6,4 +6,4 @@ title: "ListWorkspacesResponse" | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Result` | [components.ListWorkspacesResponse](../../models/components/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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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` | [components.ListWorkspacesResponse](../../models/components/listworkspacesresponse) | :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",
"id": "550e8400-e29b-41d4-a716-446655440000",
"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/metric.mdx b/docs/models/operations/metric.mdx index 9c983230..c97daf46 100644 --- a/docs/models/operations/metric.mdx +++ b/docs/models/operations/metric.mdx @@ -6,7 +6,7 @@ title: "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 | +| `DisplayFormat` | [operations.DisplayFormat](../../models/operations/displayformat) | :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` | `bool` | :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 diff --git a/docs/models/operations/operator.mdx b/docs/models/operations/operator.mdx index 786e56b5..aeaabed1 100644 --- a/docs/models/operations/operator.mdx +++ b/docs/models/operations/operator.mdx @@ -6,5 +6,5 @@ title: "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) | :heavy_check_mark: | Operator identifier used in filter definitions | eq | +| `ValueType` | [operations.ValueType](../../models/operations/valuetype) | :heavy_check_mark: | 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 ddf31902..6a0adfb0 100644 --- a/docs/models/operations/orderby.mdx +++ b/docs/models/operations/orderby.mdx @@ -6,5 +6,5 @@ title: "OrderBy" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Direction` | [operations.Direction](../../models/operations/direction.mdx) | :heavy_check_mark: | N/A | | +| `Direction` | [operations.Direction](../../models/operations/direction) | :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 diff --git a/docs/models/operations/queryanalyticsdata2.mdx b/docs/models/operations/queryanalyticsdata2.mdx index 659d18b7..22374b82 100644 --- a/docs/models/operations/queryanalyticsdata2.mdx +++ b/docs/models/operations/queryanalyticsdata2.mdx @@ -7,6 +7,6 @@ title: "QueryAnalyticsData2" | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `CachedAt` | `*float64` | :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 | +| `Data` | [][operations.QueryAnalyticsData1](../../models/operations/queryanalyticsdata1) | :heavy_check_mark: | N/A | +| `Metadata` | [operations.Metadata](../../models/operations/metadata) | :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 diff --git a/docs/models/operations/queryanalyticsrequest.mdx b/docs/models/operations/queryanalyticsrequest.mdx index 8d6ace31..56d69f82 100644 --- a/docs/models/operations/queryanalyticsrequest.mdx +++ b/docs/models/operations/queryanalyticsrequest.mdx @@ -6,13 +6,13 @@ title: "QueryAnalyticsRequest" | 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. | | +| `ClassifierDimensions` | [*operations.ClassifierDimensions](../../models/operations/classifierdimensions) | :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) | :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 | | +| `Filters` | [][operations.Filter](../../models/operations/filter) | :heavy_minus_sign: | N/A | | | `Granularity` | `*string` | :heavy_minus_sign: | Time granularity | day | | `GroupLimit` | `*int64` | :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` | `*int64` | :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 +| `OrderBy` | [*operations.OrderBy](../../models/operations/orderby) | :heavy_minus_sign: | N/A | | +| `TimeRange` | [*operations.TimeRange](../../models/operations/timerange) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/queryanalyticsresponse.mdx b/docs/models/operations/queryanalyticsresponse.mdx index 1480df4a..507c94d2 100644 --- a/docs/models/operations/queryanalyticsresponse.mdx +++ b/docs/models/operations/queryanalyticsresponse.mdx @@ -9,4 +9,4 @@ Analytics query results | 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) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/result.mdx b/docs/models/operations/result.mdx index 6a3ad02a..108c653a 100644 --- a/docs/models/operations/result.mdx +++ b/docs/models/operations/result.mdx @@ -9,6 +9,6 @@ A single rerank 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) | | +| `Document` | [operations.DocumentResponse](../../models/operations/documentresponse) | :heavy_check_mark: | The document object echoing the original input (text and/or image) | | | `Index` | `int64` | :heavy_check_mark: | Index of the document in the original input list | 0 | | `RelevanceScore` | `float64` | :heavy_check_mark: | Relevance score of the document to the query | 0.98 | \ No newline at end of file diff --git a/docs/models/operations/sendchatcompletionrequestrequest.mdx b/docs/models/operations/sendchatcompletionrequestrequest.mdx index c0c00e2a..be1f7e03 100644 --- a/docs/models/operations/sendchatcompletionrequestrequest.mdx +++ b/docs/models/operations/sendchatcompletionrequestrequest.mdx @@ -6,5 +6,5 @@ title: "SendChatCompletionRequestRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/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` | [components.ChatRequest](../../models/components/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 +| `XOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel) | :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` | [components.ChatRequest](../../models/components/chatrequest) | :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 diff --git a/docs/models/operations/updatebyokkeyrequest.mdx b/docs/models/operations/updatebyokkeyrequest.mdx index bc1e0e9c..40ce344c 100644 --- a/docs/models/operations/updatebyokkeyrequest.mdx +++ b/docs/models/operations/updatebyokkeyrequest.mdx @@ -7,4 +7,4 @@ title: "UpdateBYOKKeyRequest" | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `UpdateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file +| `UpdateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | \ No newline at end of file diff --git a/docs/models/operations/updateguardrailrequest.mdx b/docs/models/operations/updateguardrailrequest.mdx index 696bfa2b..adcd1bce 100644 --- a/docs/models/operations/updateguardrailrequest.mdx +++ b/docs/models/operations/updateguardrailrequest.mdx @@ -7,4 +7,4 @@ title: "UpdateGuardrailRequest" | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `UpdateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/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 +| `UpdateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest) | :heavy_check_mark: | 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/updatekeysrequest.mdx b/docs/models/operations/updatekeysrequest.mdx index b77a48fa..ee972cbb 100644 --- a/docs/models/operations/updatekeysrequest.mdx +++ b/docs/models/operations/updatekeysrequest.mdx @@ -7,4 +7,4 @@ title: "UpdateKeysRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | `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 +| `RequestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody) | :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 diff --git a/docs/models/operations/updatekeysrequestbody.mdx b/docs/models/operations/updatekeysrequestbody.mdx index dd213241..9e879de9 100644 --- a/docs/models/operations/updatekeysrequestbody.mdx +++ b/docs/models/operations/updatekeysrequestbody.mdx @@ -9,5 +9,5 @@ title: "UpdateKeysRequestBody" | `Disabled` | `*bool` | :heavy_minus_sign: | Whether to disable the API key | false | | `IncludeByokInLimit` | `*bool` | :heavy_minus_sign: | Whether to include BYOK usage in the limit | true | | `Limit` | optionalnullable.OptionalNullable[`float64`] | :heavy_minus_sign: | New spending limit for the API key in USD | 75 | -| `LimitReset` | optionalnullable.OptionalNullable[[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 | +| `LimitReset` | optionalnullable.OptionalNullable[[operations.UpdateKeysLimitReset](../../models/operations/updatekeyslimitreset)] | :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 diff --git a/docs/models/operations/updatekeysresponse.mdx b/docs/models/operations/updatekeysresponse.mdx index 7eef1d58..6f26924b 100644 --- a/docs/models/operations/updatekeysresponse.mdx +++ b/docs/models/operations/updatekeysresponse.mdx @@ -9,4 +9,4 @@ API key updated successfully | 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",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"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) | :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",
"hash": "f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943",
"include_byok_in_limit": false,
"label": "sk-or-v1-0e6...1c96",
"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/updateobservabilitydestinationrequest.mdx b/docs/models/operations/updateobservabilitydestinationrequest.mdx index a32db161..47cb6da5 100644 --- a/docs/models/operations/updateobservabilitydestinationrequest.mdx +++ b/docs/models/operations/updateobservabilitydestinationrequest.mdx @@ -7,4 +7,4 @@ title: "UpdateObservabilityDestinationRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `UpdateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file +| `UpdateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | \ No newline at end of file diff --git a/docs/models/operations/updateworkspacerequest.mdx b/docs/models/operations/updateworkspacerequest.mdx index 3403cdce..5670aca9 100644 --- a/docs/models/operations/updateworkspacerequest.mdx +++ b/docs/models/operations/updateworkspacerequest.mdx @@ -7,4 +7,4 @@ title: "UpdateWorkspaceRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `UpdateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file +| `UpdateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequest.mdx b/docs/models/operations/uploadfilerequest.mdx index 673bebcf..2caee303 100644 --- a/docs/models/operations/uploadfilerequest.mdx +++ b/docs/models/operations/uploadfilerequest.mdx @@ -7,5 +7,5 @@ title: "UploadFileRequest" | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `WorkspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `Provider` | [*components.FileProvider](../../models/components/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 +| `Provider` | [*components.FileProvider](../../models/components/fileprovider) | :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) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/operations/uploadfilerequestbody.mdx b/docs/models/operations/uploadfilerequestbody.mdx index b1651999..8876228f 100644 --- a/docs/models/operations/uploadfilerequestbody.mdx +++ b/docs/models/operations/uploadfilerequestbody.mdx @@ -6,4 +6,4 @@ title: "UploadFileRequestBody" | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `File` | [operations.UploadFileFile](../../models/operations/uploadfilefile.mdx) | :heavy_check_mark: | N/A | \ No newline at end of file +| `File` | [operations.UploadFileFile](../../models/operations/uploadfilefile) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/upsertworkspacebudgetrequest.mdx b/docs/models/operations/upsertworkspacebudgetrequest.mdx index 3e90704c..9f72aa6f 100644 --- a/docs/models/operations/upsertworkspacebudgetrequest.mdx +++ b/docs/models/operations/upsertworkspacebudgetrequest.mdx @@ -7,5 +7,5 @@ title: "UpsertWorkspaceBudgetRequest" | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `ID` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `UpsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | N/A | \{
"limit_usd": 100
} | \ No newline at end of file +| `Interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `UpsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest) | :heavy_check_mark: | N/A | \{
"limit_usd": 100
} | \ No newline at end of file diff --git a/docs/models/sdkerrors/badgatewayresponseerror.mdx b/docs/models/sdkerrors/badgatewayresponseerror.mdx index 4686d845..4b744744 100644 --- a/docs/models/sdkerrors/badgatewayresponseerror.mdx +++ b/docs/models/sdkerrors/badgatewayresponseerror.mdx @@ -9,6 +9,6 @@ Bad Gateway - Provider/upstream API failure | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Error` | [components.BadGatewayResponseErrorData](../../models/components/badgatewayresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | +| `Error` | [components.BadGatewayResponseErrorData](../../models/components/badgatewayresponseerrordata) | :heavy_check_mark: | Error data for BadGatewayResponse | \{
"code": 502,
"message": "Provider returned error"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/badrequestresponseerror.mdx b/docs/models/sdkerrors/badrequestresponseerror.mdx index 2010057a..2bfb7559 100644 --- a/docs/models/sdkerrors/badrequestresponseerror.mdx +++ b/docs/models/sdkerrors/badrequestresponseerror.mdx @@ -9,6 +9,6 @@ Bad Request - Invalid request parameters or malformed input | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `Error` | [components.BadRequestResponseErrorData](../../models/components/badrequestresponseerrordata.mdx) | :heavy_check_mark: | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | +| `Error` | [components.BadRequestResponseErrorData](../../models/components/badrequestresponseerrordata) | :heavy_check_mark: | Error data for BadRequestResponse | \{
"code": 400,
"message": "Invalid request parameters"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/conflictresponseerror.mdx b/docs/models/sdkerrors/conflictresponseerror.mdx index a35b8798..2905cedc 100644 --- a/docs/models/sdkerrors/conflictresponseerror.mdx +++ b/docs/models/sdkerrors/conflictresponseerror.mdx @@ -9,6 +9,6 @@ Conflict - Resource conflict or concurrent modification | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.ConflictResponseErrorData](../../models/components/conflictresponseerrordata.mdx) | :heavy_check_mark: | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | +| `Error` | [components.ConflictResponseErrorData](../../models/components/conflictresponseerrordata) | :heavy_check_mark: | Error data for ConflictResponse | \{
"code": 409,
"message": "Resource conflict. Please try again later."
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx b/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx index 18673bd4..1a14a0fe 100644 --- a/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx +++ b/docs/models/sdkerrors/edgenetworktimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Infrastructure Timeout - Provider request timed out at edge network | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.EdgeNetworkTimeoutResponseErrorData](../../models/components/edgenetworktimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | +| `Error` | [components.EdgeNetworkTimeoutResponseErrorData](../../models/components/edgenetworktimeoutresponseerrordata) | :heavy_check_mark: | Error data for EdgeNetworkTimeoutResponse | \{
"code": 524,
"message": "Request timed out. Please try again later."
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/forbiddenresponseerror.mdx b/docs/models/sdkerrors/forbiddenresponseerror.mdx index e4947ec5..da212cbb 100644 --- a/docs/models/sdkerrors/forbiddenresponseerror.mdx +++ b/docs/models/sdkerrors/forbiddenresponseerror.mdx @@ -9,6 +9,6 @@ Forbidden - Authentication successful but insufficient permissions | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `Error` | [components.ForbiddenResponseErrorData](../../models/components/forbiddenresponseerrordata.mdx) | :heavy_check_mark: | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | +| `Error` | [components.ForbiddenResponseErrorData](../../models/components/forbiddenresponseerrordata) | :heavy_check_mark: | Error data for ForbiddenResponse | \{
"code": 403,
"message": "Only management keys can perform this operation"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/internalserverresponseerror.mdx b/docs/models/sdkerrors/internalserverresponseerror.mdx index 30dde473..c0d8dc28 100644 --- a/docs/models/sdkerrors/internalserverresponseerror.mdx +++ b/docs/models/sdkerrors/internalserverresponseerror.mdx @@ -9,6 +9,6 @@ Internal Server Error - Unexpected server error | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.InternalServerResponseErrorData](../../models/components/internalserverresponseerrordata.mdx) | :heavy_check_mark: | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | +| `Error` | [components.InternalServerResponseErrorData](../../models/components/internalserverresponseerrordata) | :heavy_check_mark: | Error data for InternalServerResponse | \{
"code": 500,
"message": "Internal Server Error"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/notfoundresponseerror.mdx b/docs/models/sdkerrors/notfoundresponseerror.mdx index 5f17e90b..9e54ab79 100644 --- a/docs/models/sdkerrors/notfoundresponseerror.mdx +++ b/docs/models/sdkerrors/notfoundresponseerror.mdx @@ -9,6 +9,6 @@ Not Found - Resource does not exist | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Error` | [components.NotFoundResponseErrorData](../../models/components/notfoundresponseerrordata.mdx) | :heavy_check_mark: | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | +| `Error` | [components.NotFoundResponseErrorData](../../models/components/notfoundresponseerrordata) | :heavy_check_mark: | Error data for NotFoundResponse | \{
"code": 404,
"message": "Resource not found"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx b/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx index 9ffad631..998ca130 100644 --- a/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx +++ b/docs/models/sdkerrors/payloadtoolargeresponseerror.mdx @@ -9,6 +9,6 @@ Payload Too Large - Request payload exceeds size limits | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.PayloadTooLargeResponseErrorData](../../models/components/payloadtoolargeresponseerrordata.mdx) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | +| `Error` | [components.PayloadTooLargeResponseErrorData](../../models/components/payloadtoolargeresponseerrordata) | :heavy_check_mark: | Error data for PayloadTooLargeResponse | \{
"code": 413,
"message": "Request payload too large"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/paymentrequiredresponseerror.mdx b/docs/models/sdkerrors/paymentrequiredresponseerror.mdx index 9716a400..34fccb16 100644 --- a/docs/models/sdkerrors/paymentrequiredresponseerror.mdx +++ b/docs/models/sdkerrors/paymentrequiredresponseerror.mdx @@ -9,6 +9,6 @@ Payment Required - Insufficient credits or quota to complete request | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.PaymentRequiredResponseErrorData](../../models/components/paymentrequiredresponseerrordata.mdx) | :heavy_check_mark: | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | +| `Error` | [components.PaymentRequiredResponseErrorData](../../models/components/paymentrequiredresponseerrordata) | :heavy_check_mark: | Error data for PaymentRequiredResponse | \{
"code": 402,
"message": "Insufficient credits. Add more using https://openrouter.ai/credits"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/provideroverloadedresponseerror.mdx b/docs/models/sdkerrors/provideroverloadedresponseerror.mdx index 51153453..31503703 100644 --- a/docs/models/sdkerrors/provideroverloadedresponseerror.mdx +++ b/docs/models/sdkerrors/provideroverloadedresponseerror.mdx @@ -9,6 +9,6 @@ Provider Overloaded - Provider is temporarily overloaded | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.ProviderOverloadedResponseErrorData](../../models/components/provideroverloadedresponseerrordata.mdx) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | +| `Error` | [components.ProviderOverloadedResponseErrorData](../../models/components/provideroverloadedresponseerrordata) | :heavy_check_mark: | Error data for ProviderOverloadedResponse | \{
"code": 529,
"message": "Provider returned error"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/requesttimeoutresponseerror.mdx b/docs/models/sdkerrors/requesttimeoutresponseerror.mdx index cb88e051..3915d54d 100644 --- a/docs/models/sdkerrors/requesttimeoutresponseerror.mdx +++ b/docs/models/sdkerrors/requesttimeoutresponseerror.mdx @@ -9,6 +9,6 @@ Request Timeout - Operation exceeded time limit | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `Error` | [components.RequestTimeoutResponseErrorData](../../models/components/requesttimeoutresponseerrordata.mdx) | :heavy_check_mark: | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | +| `Error` | [components.RequestTimeoutResponseErrorData](../../models/components/requesttimeoutresponseerrordata) | :heavy_check_mark: | Error data for RequestTimeoutResponse | \{
"code": 408,
"message": "Operation timed out. Please try again later."
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/serviceunavailableresponseerror.mdx b/docs/models/sdkerrors/serviceunavailableresponseerror.mdx index 5a5b3d54..6ca4d53f 100644 --- a/docs/models/sdkerrors/serviceunavailableresponseerror.mdx +++ b/docs/models/sdkerrors/serviceunavailableresponseerror.mdx @@ -9,6 +9,6 @@ Service Unavailable - Service temporarily unavailable | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `Error` | [components.ServiceUnavailableResponseErrorData](../../models/components/serviceunavailableresponseerrordata.mdx) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | +| `Error` | [components.ServiceUnavailableResponseErrorData](../../models/components/serviceunavailableresponseerrordata) | :heavy_check_mark: | Error data for ServiceUnavailableResponse | \{
"code": 503,
"message": "Service temporarily unavailable"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx b/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx index eb7b7d8f..4848995a 100644 --- a/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx +++ b/docs/models/sdkerrors/toomanyrequestsresponseerror.mdx @@ -9,6 +9,6 @@ Too Many Requests - Rate limit exceeded | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `Error` | [components.TooManyRequestsResponseErrorData](../../models/components/toomanyrequestsresponseerrordata.mdx) | :heavy_check_mark: | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | +| `Error` | [components.TooManyRequestsResponseErrorData](../../models/components/toomanyrequestsresponseerrordata) | :heavy_check_mark: | Error data for TooManyRequestsResponse | \{
"code": 429,
"message": "Rate limit exceeded"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/unauthorizedresponseerror.mdx b/docs/models/sdkerrors/unauthorizedresponseerror.mdx index 597ae20a..58433b64 100644 --- a/docs/models/sdkerrors/unauthorizedresponseerror.mdx +++ b/docs/models/sdkerrors/unauthorizedresponseerror.mdx @@ -9,6 +9,6 @@ Unauthorized - Authentication required or invalid credentials | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `Error` | [components.UnauthorizedResponseErrorData](../../models/components/unauthorizedresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | +| `Error` | [components.UnauthorizedResponseErrorData](../../models/components/unauthorizedresponseerrordata) | :heavy_check_mark: | Error data for UnauthorizedResponse | \{
"code": 401,
"message": "Missing Authentication header"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/sdkerrors/unprocessableentityresponseerror.mdx b/docs/models/sdkerrors/unprocessableentityresponseerror.mdx index 41537253..340c2c29 100644 --- a/docs/models/sdkerrors/unprocessableentityresponseerror.mdx +++ b/docs/models/sdkerrors/unprocessableentityresponseerror.mdx @@ -9,6 +9,6 @@ Unprocessable Entity - Semantic validation failure | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `Error` | [components.UnprocessableEntityResponseErrorData](../../models/components/unprocessableentityresponseerrordata.mdx) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | +| `Error` | [components.UnprocessableEntityResponseErrorData](../../models/components/unprocessableentityresponseerrordata) | :heavy_check_mark: | Error data for UnprocessableEntityResponse | \{
"code": 422,
"message": "Invalid argument"
} | | `OpenrouterMetadata` | map[string]`any` | :heavy_minus_sign: | N/A | | | `UserID` | `*string` | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/sdks/analytics/README.mdx b/docs/sdks/analytics/README.mdx index 133ba583..1948ee65 100644 --- a/docs/sdks/analytics/README.mdx +++ b/docs/sdks/analytics/README.mdx @@ -52,11 +52,11 @@ func main() { | `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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.ActivityResponse](../../models/components/activityresponse.mdx), error** +**[*components.ActivityResponse](../../models/components/activityresponse), error** ### Errors diff --git a/docs/sdks/apikeys/README.mdx b/docs/sdks/apikeys/README.mdx index 0648a3cd..af24cb63 100644 --- a/docs/sdks/apikeys/README.mdx +++ b/docs/sdks/apikeys/README.mdx @@ -54,11 +54,11 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.GetCurrentKeyResponse](../../models/operations/getcurrentkeyresponse.mdx), error** +**[*operations.GetCurrentKeyResponse](../../models/operations/getcurrentkeyresponse), error** ### Errors @@ -110,11 +110,11 @@ func main() { | `includeDisabled` | `*bool` | :heavy_minus_sign: | Whether to include disabled API keys in the response | false | | `offset` | optionalnullable.OptionalNullable[`int64`] | :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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListResponse](../../models/operations/listresponse.mdx), error** +**[*operations.ListResponse](../../models/operations/listresponse), error** ### Errors @@ -173,12 +173,12 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.CreateKeysRequest](../../models/operations/createkeysrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.CreateKeysResponse](../../models/operations/createkeysresponse.mdx), error** +**[*operations.CreateKeysResponse](../../models/operations/createkeysresponse), error** ### Errors @@ -230,11 +230,11 @@ func main() { | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to delete | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.DeleteKeysResponse](../../models/operations/deletekeysresponse.mdx), error** +**[*operations.DeleteKeysResponse](../../models/operations/deletekeysresponse), error** ### Errors @@ -285,11 +285,11 @@ func main() { | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `hash` | `string` | :heavy_check_mark: | The hash identifier of the API key to retrieve | f01d52606dc8f0a8303a7b5cc3fa07109c2e346cec7c0a16b40de462992ce943 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.GetKeyResponse](../../models/operations/getkeyresponse.mdx), error** +**[*operations.GetKeyResponse](../../models/operations/getkeyresponse), error** ### Errors @@ -348,12 +348,12 @@ func main() { | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `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"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `requestBody` | [operations.UpdateKeysRequestBody](../../models/operations/updatekeysrequestbody) | :heavy_check_mark: | N/A | \{
"disabled": false,
"include_byok_in_limit": true,
"limit": 75,
"limit_reset": "daily",
"name": "Updated API Key Name"
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.UpdateKeysResponse](../../models/operations/updatekeysresponse.mdx), error** +**[*operations.UpdateKeysResponse](../../models/operations/updatekeysresponse), error** ### Errors diff --git a/docs/sdks/benchmarks/README.mdx b/docs/sdks/benchmarks/README.mdx index 8734098f..cf2f5bf6 100644 --- a/docs/sdks/benchmarks/README.mdx +++ b/docs/sdks/benchmarks/README.mdx @@ -49,12 +49,12 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.GetBenchmarksRequest](../../models/operations/getbenchmarksrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.UnifiedBenchmarksResponse](../../models/components/unifiedbenchmarksresponse.mdx), error** +**[*components.UnifiedBenchmarksResponse](../../models/components/unifiedbenchmarksresponse), error** ### Errors diff --git a/docs/sdks/betaanalytics/README.mdx b/docs/sdks/betaanalytics/README.mdx index d0021f47..f6fc31dc 100644 --- a/docs/sdks/betaanalytics/README.mdx +++ b/docs/sdks/betaanalytics/README.mdx @@ -50,11 +50,11 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.GetAnalyticsMetaResponse](../../models/operations/getanalyticsmetaresponse.mdx), error** +**[*operations.GetAnalyticsMetaResponse](../../models/operations/getanalyticsmetaresponse), error** ### Errors @@ -118,12 +118,12 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.QueryAnalyticsRequest](../../models/operations/queryanalyticsrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.QueryAnalyticsResponse](../../models/operations/queryanalyticsresponse.mdx), error** +**[*operations.QueryAnalyticsResponse](../../models/operations/queryanalyticsresponse), error** ### Errors diff --git a/docs/sdks/betaresponses/README.mdx b/docs/sdks/betaresponses/README.mdx index 71d14851..50db07f5 100644 --- a/docs/sdks/betaresponses/README.mdx +++ b/docs/sdks/betaresponses/README.mdx @@ -91,13 +91,13 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `responsesRequest` | [components.ResponsesRequest](../../models/components/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
} | -| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest) | :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
} | +| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel) | :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 | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.CreateResponsesResponse](../../models/operations/createresponsesresponse.mdx), error** +**[*operations.CreateResponsesResponse](../../models/operations/createresponsesresponse), error** ### Errors diff --git a/docs/sdks/byok/README.mdx b/docs/sdks/byok/README.mdx index 7cc6e217..469dd4d1 100644 --- a/docs/sdks/byok/README.mdx +++ b/docs/sdks/byok/README.mdx @@ -69,12 +69,12 @@ func main() { | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :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 | -| `provider` | [*operations.Provider](../../models/operations/provider.mdx) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `provider` | [*operations.Provider](../../models/operations/provider) | :heavy_minus_sign: | Optional provider slug to filter by (e.g. `openai`, `anthropic`, `amazon-bedrock`). | openai | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListBYOKKeysResponse](../../models/operations/listbyokkeysresponse.mdx), error** +**[*operations.ListBYOKKeysResponse](../../models/operations/listbyokkeysresponse), error** ### Errors @@ -129,12 +129,12 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateBYOKKeyRequest](../../models/components/createbyokkeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [components.CreateBYOKKeyRequest](../../models/components/createbyokkeyrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.CreateBYOKKeyResponse](../../models/components/createbyokkeyresponse.mdx), error** +**[*components.CreateBYOKKeyResponse](../../models/components/createbyokkeyresponse), error** ### Errors @@ -185,11 +185,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.DeleteBYOKKeyResponse](../../models/components/deletebyokkeyresponse.mdx), error** +**[*components.DeleteBYOKKeyResponse](../../models/components/deletebyokkeyresponse), error** ### Errors @@ -239,11 +239,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.GetBYOKKeyResponse](../../models/components/getbyokkeyresponse.mdx), error** +**[*components.GetBYOKKeyResponse](../../models/components/getbyokkeyresponse), error** ### Errors @@ -298,12 +298,12 @@ func main() { | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The BYOK credential ID (UUID). | 11111111-2222-3333-4444-555555555555 | -| `updateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest.mdx) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `updateBYOKKeyRequest` | [components.UpdateBYOKKeyRequest](../../models/components/updatebyokkeyrequest) | :heavy_check_mark: | N/A | \{
"disabled": false,
"name": "Updated OpenAI Key"
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.UpdateBYOKKeyResponse](../../models/components/updatebyokkeyresponse.mdx), error** +**[*components.UpdateBYOKKeyResponse](../../models/components/updatebyokkeyresponse), error** ### Errors diff --git a/docs/sdks/chat/README.mdx b/docs/sdks/chat/README.mdx index 783551d5..0d7916f3 100644 --- a/docs/sdks/chat/README.mdx +++ b/docs/sdks/chat/README.mdx @@ -126,13 +126,13 @@ func main() { | Parameter | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `chatRequest` | [components.ChatRequest](../../models/components/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
} | -| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest) | :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
} | +| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel) | :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 | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.SendChatCompletionRequestResponse](../../models/operations/sendchatcompletionrequestresponse.mdx), error** +**[*operations.SendChatCompletionRequestResponse](../../models/operations/sendchatcompletionrequestresponse), error** ### Errors diff --git a/docs/sdks/classifications/README.mdx b/docs/sdks/classifications/README.mdx index 1ba80d0a..b32ec48f 100644 --- a/docs/sdks/classifications/README.mdx +++ b/docs/sdks/classifications/README.mdx @@ -68,12 +68,12 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `window` | [*operations.Window](../../models/operations/window) | :heavy_minus_sign: | Trailing time window for the classification data. Currently only `7d` (trailing 7 days) is supported. | 7d | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.TaskClassificationResponse](../../models/components/taskclassificationresponse.mdx), error** +**[*components.TaskClassificationResponse](../../models/components/taskclassificationresponse), error** ### Errors diff --git a/docs/sdks/credits/README.mdx b/docs/sdks/credits/README.mdx index 7ddbb546..324ef1ed 100644 --- a/docs/sdks/credits/README.mdx +++ b/docs/sdks/credits/README.mdx @@ -49,11 +49,11 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.GetCreditsResponse](../../models/operations/getcreditsresponse.mdx), error** +**[*operations.GetCreditsResponse](../../models/operations/getcreditsresponse), error** ### Errors diff --git a/docs/sdks/datasets/README.mdx b/docs/sdks/datasets/README.mdx index 55f3746b..87e9354f 100644 --- a/docs/sdks/datasets/README.mdx +++ b/docs/sdks/datasets/README.mdx @@ -85,12 +85,12 @@ func main() { | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.GetAppRankingsRequest](../../models/operations/getapprankingsrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.GetAppRankingsResponse](../../models/operations/getapprankingsresponse.mdx), error** +**[*operations.GetAppRankingsResponse](../../models/operations/getapprankingsresponse), error** ### Errors @@ -165,12 +165,12 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.GetRankingsDailyRequest](../../models/operations/getrankingsdailyrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.RankingsDailyResponse](../../models/components/rankingsdailyresponse.mdx), error** +**[*components.RankingsDailyResponse](../../models/components/rankingsdailyresponse), error** ### Errors diff --git a/docs/sdks/embeddings/README.mdx b/docs/sdks/embeddings/README.mdx index fe50a5a5..f8aa0982 100644 --- a/docs/sdks/embeddings/README.mdx +++ b/docs/sdks/embeddings/README.mdx @@ -56,12 +56,12 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.CreateEmbeddingsRequest](../../models/operations/createembeddingsrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.CreateEmbeddingsResponse](../../models/operations/createembeddingsresponse.mdx), error** +**[*operations.CreateEmbeddingsResponse](../../models/operations/createembeddingsresponse), error** ### Errors @@ -132,11 +132,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListEmbeddingsModelsResponse](../../models/operations/listembeddingsmodelsresponse.mdx), error** +**[*operations.ListEmbeddingsModelsResponse](../../models/operations/listembeddingsmodelsresponse), error** ### Errors diff --git a/docs/sdks/endpoints/README.mdx b/docs/sdks/endpoints/README.mdx index 844044ad..9f698e64 100644 --- a/docs/sdks/endpoints/README.mdx +++ b/docs/sdks/endpoints/README.mdx @@ -50,11 +50,11 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.ListEndpointsZdrResponse](../../models/operations/listendpointszdrresponse.mdx), error** +**[*operations.ListEndpointsZdrResponse](../../models/operations/listendpointszdrresponse), error** ### Errors @@ -104,11 +104,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `author` | `string` | :heavy_check_mark: | The author/organization of the model | openai | | `slug` | `string` | :heavy_check_mark: | The model slug | gpt-4 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListEndpointsResponse](../../models/operations/listendpointsresponse.mdx), error** +**[*operations.ListEndpointsResponse](../../models/operations/listendpointsresponse), error** ### Errors diff --git a/docs/sdks/files/README.mdx b/docs/sdks/files/README.mdx index bb400297..67f336f9 100644 --- a/docs/sdks/files/README.mdx +++ b/docs/sdks/files/README.mdx @@ -69,12 +69,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.ListFilesRequest](../../models/operations/listfilesrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.ListFilesResponse](../../models/operations/listfilesresponse.mdx), error** +**[*operations.ListFilesResponse](../../models/operations/listfilesresponse), error** ### Errors @@ -149,14 +149,14 @@ func main() { | Parameter | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody.mdx) | :heavy_check_mark: | N/A | | +| `requestBody` | [operations.UploadFileRequestBody](../../models/operations/uploadfilerequestbody) | :heavy_check_mark: | N/A | | | `workspaceID` | `*string` | :heavy_minus_sign: | Workspace to scope the request to. Defaults to the caller’s default workspace. | a103d8b6-42f0-4e50-9a3c-bf41e2c3c1a7 | -| `provider` | [*components.FileProvider](../../models/components/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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `provider` | [*components.FileProvider](../../models/components/fileprovider) | :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 | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.FileResponse](../../models/components/fileresponse.mdx), error** +**[*components.FileResponse](../../models/components/fileresponse), error** ### Errors @@ -223,12 +223,12 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `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` | [*components.FileProvider](../../models/components/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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `provider` | [*components.FileProvider](../../models/components/fileprovider) | :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 | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.FileDeleteResponse](../../models/components/filedeleteresponse.mdx), error** +**[*components.FileDeleteResponse](../../models/components/filedeleteresponse), error** ### Errors @@ -294,12 +294,12 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `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` | [*components.FileProvider](../../models/components/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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `provider` | [*components.FileProvider](../../models/components/fileprovider) | :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 | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.FileResponse](../../models/components/fileresponse.mdx), error** +**[*components.FileResponse](../../models/components/fileresponse), error** ### Errors @@ -355,12 +355,12 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `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` | [*components.FileProvider](../../models/components/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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `provider` | [*components.FileProvider](../../models/components/fileprovider) | :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 | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[io.ReadCloser](../../.mdx), error** +**[io.ReadCloser](../../), error** ### Errors diff --git a/docs/sdks/generations/README.mdx b/docs/sdks/generations/README.mdx index 4b03e3aa..03a98f8e 100644 --- a/docs/sdks/generations/README.mdx +++ b/docs/sdks/generations/README.mdx @@ -52,11 +52,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.GenerationResponse](../../models/components/generationresponse.mdx), error** +**[*components.GenerationResponse](../../models/components/generationresponse), error** ### Errors @@ -111,11 +111,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The generation ID | gen-1234567890 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.GenerationContentResponse](../../models/components/generationcontentresponse.mdx), error** +**[*components.GenerationContentResponse](../../models/components/generationcontentresponse), error** ### Errors @@ -174,12 +174,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.SubmitGenerationFeedbackRequest](../../models/components/submitgenerationfeedbackrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [components.SubmitGenerationFeedbackRequest](../../models/components/submitgenerationfeedbackrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.SubmitGenerationFeedbackResponse](../../models/components/submitgenerationfeedbackresponse.mdx), error** +**[*components.SubmitGenerationFeedbackResponse](../../models/components/submitgenerationfeedbackresponse), error** ### Errors diff --git a/docs/sdks/guardrails/README.mdx b/docs/sdks/guardrails/README.mdx index c68197d0..275bea52 100644 --- a/docs/sdks/guardrails/README.mdx +++ b/docs/sdks/guardrails/README.mdx @@ -77,11 +77,11 @@ func main() { | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListGuardrailsResponse](../../models/operations/listguardrailsresponse.mdx), error** +**[*operations.ListGuardrailsResponse](../../models/operations/listguardrailsresponse), error** ### Errors @@ -150,12 +150,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateGuardrailRequest](../../models/components/createguardrailrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [components.CreateGuardrailRequest](../../models/components/createguardrailrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.CreateGuardrailResponse](../../models/components/createguardrailresponse.mdx), error** +**[*components.CreateGuardrailResponse](../../models/components/createguardrailresponse), error** ### Errors @@ -206,11 +206,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to delete | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.DeleteGuardrailResponse](../../models/components/deleteguardrailresponse.mdx), error** +**[*components.DeleteGuardrailResponse](../../models/components/deleteguardrailresponse), error** ### Errors @@ -260,11 +260,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to retrieve | 550e8400-e29b-41d4-a716-446655440000 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.GetGuardrailResponse](../../models/components/getguardrailresponse.mdx), error** +**[*components.GetGuardrailResponse](../../models/components/getguardrailresponse), error** ### Errors @@ -321,12 +321,12 @@ func main() { | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail to update | 550e8400-e29b-41d4-a716-446655440000 | -| `updateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest.mdx) | :heavy_check_mark: | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `updateGuardrailRequest` | [components.UpdateGuardrailRequest](../../models/components/updateguardrailrequest) | :heavy_check_mark: | N/A | \{
"description": "Updated description",
"limit_usd": 75,
"name": "Updated Guardrail Name",
"reset_interval": "weekly"
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.UpdateGuardrailResponse](../../models/components/updateguardrailresponse.mdx), error** +**[*components.UpdateGuardrailResponse](../../models/components/updateguardrailresponse), error** ### Errors @@ -392,11 +392,11 @@ func main() { | `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListGuardrailKeyAssignmentsResponse](../../models/operations/listguardrailkeyassignmentsresponse.mdx), error** +**[*operations.ListGuardrailKeyAssignmentsResponse](../../models/operations/listguardrailkeyassignmentsresponse), error** ### Errors @@ -451,12 +451,12 @@ func main() { | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `bulkAssignKeysRequest` | [components.BulkAssignKeysRequest](../../models/components/bulkassignkeysrequest) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.BulkAssignKeysResponse](../../models/components/bulkassignkeysresponse.mdx), error** +**[*components.BulkAssignKeysResponse](../../models/components/bulkassignkeysresponse), error** ### Errors @@ -512,12 +512,12 @@ func main() { | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest.mdx) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `bulkUnassignKeysRequest` | [components.BulkUnassignKeysRequest](../../models/components/bulkunassignkeysrequest) | :heavy_check_mark: | N/A | \{
"key_hashes": [
"c56454edb818d6b14bc0d61c46025f1450b0f4012d12304ab40aacb519fcbc93"
]
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.BulkUnassignKeysResponse](../../models/components/bulkunassignkeysresponse.mdx), error** +**[*components.BulkUnassignKeysResponse](../../models/components/bulkunassignkeysresponse), error** ### Errors @@ -583,11 +583,11 @@ func main() { | `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListGuardrailMemberAssignmentsResponse](../../models/operations/listguardrailmemberassignmentsresponse.mdx), error** +**[*operations.ListGuardrailMemberAssignmentsResponse](../../models/operations/listguardrailmemberassignmentsresponse), error** ### Errors @@ -643,12 +643,12 @@ func main() { | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `bulkAssignMembersRequest` | [components.BulkAssignMembersRequest](../../models/components/bulkassignmembersrequest) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.BulkAssignMembersResponse](../../models/components/bulkassignmembersresponse.mdx), error** +**[*components.BulkAssignMembersResponse](../../models/components/bulkassignmembersresponse), error** ### Errors @@ -705,12 +705,12 @@ func main() { | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The unique identifier of the guardrail | 550e8400-e29b-41d4-a716-446655440000 | -| `bulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `bulkUnassignMembersRequest` | [components.BulkUnassignMembersRequest](../../models/components/bulkunassignmembersrequest) | :heavy_check_mark: | N/A | \{
"member_user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.BulkUnassignMembersResponse](../../models/components/bulkunassignmembersresponse.mdx), error** +**[*components.BulkUnassignMembersResponse](../../models/components/bulkunassignmembersresponse), error** ### Errors @@ -775,11 +775,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListKeyAssignmentsResponse](../../models/operations/listkeyassignmentsresponse.mdx), error** +**[*operations.ListKeyAssignmentsResponse](../../models/operations/listkeyassignmentsresponse), error** ### Errors @@ -842,11 +842,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListMemberAssignmentsResponse](../../models/operations/listmemberassignmentsresponse.mdx), error** +**[*operations.ListMemberAssignmentsResponse](../../models/operations/listmemberassignmentsresponse), error** ### Errors diff --git a/docs/sdks/images/README.mdx b/docs/sdks/images/README.mdx index 9abe56d2..eb29b54f 100644 --- a/docs/sdks/images/README.mdx +++ b/docs/sdks/images/README.mdx @@ -61,12 +61,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.ImageGenerationRequest](../../models/components/imagegenerationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [components.ImageGenerationRequest](../../models/components/imagegenerationrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.CreateImagesResponse](../../models/operations/createimagesresponse.mdx), error** +**[*operations.CreateImagesResponse](../../models/operations/createimagesresponse), error** ### Errors @@ -123,11 +123,11 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.ImageModelsListResponse](../../models/components/imagemodelslistresponse.mdx), error** +**[*components.ImageModelsListResponse](../../models/components/imagemodelslistresponse), error** ### Errors @@ -176,11 +176,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `author` | `string` | :heavy_check_mark: | Model author/organization | bytedance-seed | | `slug` | `string` | :heavy_check_mark: | Model slug | seedream-4.5 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.ImageModelEndpointsResponse](../../models/components/imagemodelendpointsresponse.mdx), error** +**[*components.ImageModelEndpointsResponse](../../models/components/imagemodelendpointsresponse), error** ### Errors diff --git a/docs/sdks/models/README.mdx b/docs/sdks/models/README.mdx index 55fa4cbf..8632c0d7 100644 --- a/docs/sdks/models/README.mdx +++ b/docs/sdks/models/README.mdx @@ -54,11 +54,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.ModelResponse](../../models/components/modelresponse.mdx), error** +**[*components.ModelResponse](../../models/components/modelresponse), error** ### Errors @@ -120,12 +120,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.GetModelsRequest](../../models/operations/getmodelsrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.GetModelsResponse](../../models/operations/getmodelsresponse.mdx), error** +**[*operations.GetModelsResponse](../../models/operations/getmodelsresponse), error** ### Errors @@ -175,11 +175,11 @@ func main() { | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `outputModalities` | `*string` | :heavy_minus_sign: | Filter models by output modality. Accepts a comma-separated list of modalities (text, image, audio, embeddings) or "all" to include all models. Defaults to "text". | text | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.ModelsCountResponse](../../models/components/modelscountresponse.mdx), error** +**[*components.ModelsCountResponse](../../models/components/modelscountresponse), error** ### Errors @@ -242,14 +242,14 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity.mdx) | :heavy_check_mark: | The security requirements to use for the request. | | +| `security` | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity) | :heavy_check_mark: | The security requirements to use for the request. | | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination. When both offset and limit are omitted, the full list is returned | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 1000). When both offset and limit are omitted, the full list is returned | 500 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListModelsUserResponse](../../models/operations/listmodelsuserresponse.mdx), error** +**[*operations.ListModelsUserResponse](../../models/operations/listmodelsuserresponse), error** ### Errors diff --git a/docs/sdks/oauth/README.mdx b/docs/sdks/oauth/README.mdx index 7de1192d..709f70c9 100644 --- a/docs/sdks/oauth/README.mdx +++ b/docs/sdks/oauth/README.mdx @@ -56,12 +56,12 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.ExchangeAuthCodeForAPIKeyRequest](../../models/operations/exchangeauthcodeforapikeyrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.ExchangeAuthCodeForAPIKeyResponse](../../models/operations/exchangeauthcodeforapikeyresponse.mdx), error** +**[*operations.ExchangeAuthCodeForAPIKeyResponse](../../models/operations/exchangeauthcodeforapikeyresponse), error** ### Errors @@ -116,12 +116,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.CreateAuthKeysCodeRequest](../../models/operations/createauthkeyscoderequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.CreateAuthKeysCodeResponse](../../models/operations/createauthkeyscoderesponse.mdx), error** +**[*operations.CreateAuthKeysCodeResponse](../../models/operations/createauthkeyscoderesponse), error** ### Errors diff --git a/docs/sdks/observability/README.mdx b/docs/sdks/observability/README.mdx index e26c8b9b..15180638 100644 --- a/docs/sdks/observability/README.mdx +++ b/docs/sdks/observability/README.mdx @@ -69,11 +69,11 @@ func main() { | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListObservabilityDestinationsResponse](../../models/operations/listobservabilitydestinationsresponse.mdx), error** +**[*operations.ListObservabilityDestinationsResponse](../../models/operations/listobservabilitydestinationsresponse), error** ### Errors @@ -169,12 +169,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateObservabilityDestinationRequest](../../models/components/createobservabilitydestinationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [components.CreateObservabilityDestinationRequest](../../models/components/createobservabilitydestinationrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.CreateObservabilityDestinationResponse](../../models/components/createobservabilitydestinationresponse.mdx), error** +**[*components.CreateObservabilityDestinationResponse](../../models/components/createobservabilitydestinationresponse), error** ### Errors @@ -226,11 +226,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.DeleteObservabilityDestinationResponse](../../models/components/deleteobservabilitydestinationresponse.mdx), error** +**[*components.DeleteObservabilityDestinationResponse](../../models/components/deleteobservabilitydestinationresponse), error** ### Errors @@ -319,11 +319,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.GetObservabilityDestinationResponse](../../models/components/getobservabilitydestinationresponse.mdx), error** +**[*components.GetObservabilityDestinationResponse](../../models/components/getobservabilitydestinationresponse), error** ### Errors @@ -415,12 +415,12 @@ func main() { | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The destination ID (UUID). | 99999999-aaaa-bbbb-cccc-dddddddddddd | -| `updateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest.mdx) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `updateObservabilityDestinationRequest` | [components.UpdateObservabilityDestinationRequest](../../models/components/updateobservabilitydestinationrequest) | :heavy_check_mark: | N/A | \{
"enabled": false,
"name": "Updated Langfuse"
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.UpdateObservabilityDestinationResponse](../../models/components/updateobservabilitydestinationresponse.mdx), error** +**[*components.UpdateObservabilityDestinationResponse](../../models/components/updateobservabilitydestinationresponse), error** ### Errors diff --git a/docs/sdks/organization/README.mdx b/docs/sdks/organization/README.mdx index 790213d0..4fe94675 100644 --- a/docs/sdks/organization/README.mdx +++ b/docs/sdks/organization/README.mdx @@ -64,11 +64,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListOrganizationMembersResponse](../../models/operations/listorganizationmembersresponse.mdx), error** +**[*operations.ListOrganizationMembersResponse](../../models/operations/listorganizationmembersresponse), error** ### Errors diff --git a/docs/sdks/presets/README.mdx b/docs/sdks/presets/README.mdx index 95c801d8..ab90e81e 100644 --- a/docs/sdks/presets/README.mdx +++ b/docs/sdks/presets/README.mdx @@ -70,11 +70,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListPresetsResponse](../../models/operations/listpresetsresponse.mdx), error** +**[*operations.ListPresetsResponse](../../models/operations/listpresetsresponse), error** ### Errors @@ -124,11 +124,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.GetPresetResponse](../../models/components/getpresetresponse.mdx), error** +**[*components.GetPresetResponse](../../models/components/getpresetresponse), error** ### Errors @@ -202,12 +202,12 @@ func main() { | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `chatRequest` | [components.ChatRequest](../../models/components/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
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `chatRequest` | [components.ChatRequest](../../models/components/chatrequest) | :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
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.CreatePresetFromInferenceResponse](../../models/components/createpresetfrominferenceresponse.mdx), error** +**[*components.CreatePresetFromInferenceResponse](../../models/components/createpresetfrominferenceresponse), error** ### Errors @@ -275,12 +275,12 @@ func main() { | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `messagesRequest` | [components.MessagesRequest](../../models/components/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
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `messagesRequest` | [components.MessagesRequest](../../models/components/messagesrequest) | :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
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.CreatePresetFromInferenceResponse](../../models/components/createpresetfrominferenceresponse.mdx), error** +**[*components.CreatePresetFromInferenceResponse](../../models/components/createpresetfrominferenceresponse), error** ### Errors @@ -341,12 +341,12 @@ func main() { | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. Created if it does not exist. | my-preset | -| `responsesRequest` | [components.ResponsesRequest](../../models/components/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
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest) | :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
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.CreatePresetFromInferenceResponse](../../models/components/createpresetfrominferenceresponse.mdx), error** +**[*components.CreatePresetFromInferenceResponse](../../models/components/createpresetfrominferenceresponse), error** ### Errors @@ -414,11 +414,11 @@ func main() { | `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListPresetVersionsResponse](../../models/operations/listpresetversionsresponse.mdx), error** +**[*operations.ListPresetVersionsResponse](../../models/operations/listpresetversionsresponse), error** ### Errors @@ -470,11 +470,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `slug` | `string` | :heavy_check_mark: | URL-safe slug identifying the preset. | my-preset | | `version` | `string` | :heavy_check_mark: | Version number of the preset. | 1 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.GetPresetVersionResponse](../../models/components/getpresetversionresponse.mdx), error** +**[*components.GetPresetVersionResponse](../../models/components/getpresetversionresponse), error** ### Errors diff --git a/docs/sdks/providers/README.mdx b/docs/sdks/providers/README.mdx index 783dc0ff..f0fb9625 100644 --- a/docs/sdks/providers/README.mdx +++ b/docs/sdks/providers/README.mdx @@ -49,11 +49,11 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.ListProvidersResponse](../../models/operations/listprovidersresponse.mdx), error** +**[*operations.ListProvidersResponse](../../models/operations/listprovidersresponse), error** ### Errors diff --git a/docs/sdks/rerank/README.mdx b/docs/sdks/rerank/README.mdx index 830fed45..bb726c56 100644 --- a/docs/sdks/rerank/README.mdx +++ b/docs/sdks/rerank/README.mdx @@ -61,12 +61,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.CreateRerankRequest](../../models/operations/creatererankrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*operations.CreateRerankResponse](../../models/operations/creatererankresponse.mdx), error** +**[*operations.CreateRerankResponse](../../models/operations/creatererankresponse), error** ### Errors diff --git a/docs/sdks/responses/README.mdx b/docs/sdks/responses/README.mdx index ab1b772c..f73ab45b 100644 --- a/docs/sdks/responses/README.mdx +++ b/docs/sdks/responses/README.mdx @@ -91,13 +91,13 @@ func main() { | Parameter | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | -| `responsesRequest` | [components.ResponsesRequest](../../models/components/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
} | -| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/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 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `responsesRequest` | [components.ResponsesRequest](../../models/components/responsesrequest) | :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
} | +| `xOpenRouterMetadata` | [*components.MetadataLevel](../../models/components/metadatalevel) | :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 | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.CreateResponsesResponse](../../models/operations/createresponsesresponse.mdx), error** +**[*operations.CreateResponsesResponse](../../models/operations/createresponsesresponse), error** ### Errors diff --git a/docs/sdks/stt/README.mdx b/docs/sdks/stt/README.mdx index 82330b9e..43ebb30e 100644 --- a/docs/sdks/stt/README.mdx +++ b/docs/sdks/stt/README.mdx @@ -58,12 +58,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.STTRequest](../../models/components/sttrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [components.STTRequest](../../models/components/sttrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.STTResponse](../../models/components/sttresponse.mdx), error** +**[*components.STTResponse](../../models/components/sttresponse), error** ### Errors @@ -132,12 +132,12 @@ func main() { | Parameter | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [operations.CreateAudioTranscriptionsMultipartRequest](../../models/operations/createaudiotranscriptionsmultipartrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.STTResponse](../../models/components/sttresponse.mdx), error** +**[*components.STTResponse](../../models/components/sttresponse), error** ### Errors diff --git a/docs/sdks/tts/README.mdx b/docs/sdks/tts/README.mdx index 02b71e92..168fc1c0 100644 --- a/docs/sdks/tts/README.mdx +++ b/docs/sdks/tts/README.mdx @@ -55,12 +55,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.SpeechRequest](../../models/components/speechrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [components.SpeechRequest](../../models/components/speechrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[io.ReadCloser](../../.mdx), error** +**[io.ReadCloser](../../), error** ### Errors diff --git a/docs/sdks/videogeneration/README.mdx b/docs/sdks/videogeneration/README.mdx index 4604686e..611f5d65 100644 --- a/docs/sdks/videogeneration/README.mdx +++ b/docs/sdks/videogeneration/README.mdx @@ -59,12 +59,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.VideoGenerationRequest](../../models/components/videogenerationrequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [components.VideoGenerationRequest](../../models/components/videogenerationrequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.VideoGenerationResponse](../../models/components/videogenerationresponse.mdx), error** +**[*components.VideoGenerationResponse](../../models/components/videogenerationresponse), error** ### Errors @@ -117,11 +117,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `jobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.VideoGenerationResponse](../../models/components/videogenerationresponse.mdx), error** +**[*components.VideoGenerationResponse](../../models/components/videogenerationresponse), error** ### Errors @@ -173,11 +173,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `jobID` | `string` | :heavy_check_mark: | N/A | job-abc123 | | `index` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | N/A | 0 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[io.ReadCloser](../../.mdx), error** +**[io.ReadCloser](../../), error** ### Errors @@ -228,11 +228,11 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.VideoModelsListResponse](../../models/components/videomodelslistresponse.mdx), error** +**[*components.VideoModelsListResponse](../../models/components/videomodelslistresponse), error** ### Errors diff --git a/docs/sdks/workspaces/README.mdx b/docs/sdks/workspaces/README.mdx index 75acb1ac..a63ef767 100644 --- a/docs/sdks/workspaces/README.mdx +++ b/docs/sdks/workspaces/README.mdx @@ -74,11 +74,11 @@ func main() { | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListWorkspacesResponse](../../models/operations/listworkspacesresponse.mdx), error** +**[*operations.ListWorkspacesResponse](../../models/operations/listworkspacesresponse), error** ### Errors @@ -135,12 +135,12 @@ func main() { | Parameter | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | -| `request` | [components.CreateWorkspaceRequest](../../models/components/createworkspacerequest.mdx) | :heavy_check_mark: | The request object to use for the request. | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | +| `request` | [components.CreateWorkspaceRequest](../../models/components/createworkspacerequest) | :heavy_check_mark: | The request object to use for the request. | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | ### Response -**[*components.CreateWorkspaceResponse](../../models/components/createworkspaceresponse.mdx), error** +**[*components.CreateWorkspaceResponse](../../models/components/createworkspaceresponse), error** ### Errors @@ -191,11 +191,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.DeleteWorkspaceResponse](../../models/components/deleteworkspaceresponse.mdx), error** +**[*components.DeleteWorkspaceResponse](../../models/components/deleteworkspaceresponse), error** ### Errors @@ -247,11 +247,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.GetWorkspaceResponse](../../models/components/getworkspaceresponse.mdx), error** +**[*components.GetWorkspaceResponse](../../models/components/getworkspaceresponse), error** ### Errors @@ -305,12 +305,12 @@ func main() { | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `updateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest.mdx) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `updateWorkspaceRequest` | [components.UpdateWorkspaceRequest](../../models/components/updateworkspacerequest) | :heavy_check_mark: | N/A | \{
"name": "Updated Workspace",
"slug": "updated-workspace"
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.UpdateWorkspaceResponse](../../models/components/updateworkspaceresponse.mdx), error** +**[*components.UpdateWorkspaceResponse](../../models/components/updateworkspaceresponse), error** ### Errors @@ -362,11 +362,11 @@ func main() { | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.ListWorkspaceBudgetsResponse](../../models/components/listworkspacebudgetsresponse.mdx), error** +**[*components.ListWorkspaceBudgetsResponse](../../models/components/listworkspacebudgetsresponse), error** ### Errors @@ -417,12 +417,12 @@ func main() { | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.DeleteWorkspaceBudgetResponse](../../models/components/deleteworkspacebudgetresponse.mdx), error** +**[*components.DeleteWorkspaceBudgetResponse](../../models/components/deleteworkspacebudgetresponse), error** ### Errors @@ -475,13 +475,13 @@ func main() { | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval.mdx) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | -| `upsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest.mdx) | :heavy_check_mark: | N/A | \{
"limit_usd": 100
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `interval` | [components.WorkspaceBudgetInterval](../../models/components/workspacebudgetinterval) | :heavy_check_mark: | Budget reset interval. Use "lifetime" for a one-time budget that never resets. | monthly | +| `upsertWorkspaceBudgetRequest` | [components.UpsertWorkspaceBudgetRequest](../../models/components/upsertworkspacebudgetrequest) | :heavy_check_mark: | N/A | \{
"limit_usd": 100
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.UpsertWorkspaceBudgetResponse](../../models/components/upsertworkspacebudgetresponse.mdx), error** +**[*components.UpsertWorkspaceBudgetResponse](../../models/components/upsertworkspacebudgetresponse), error** ### Errors @@ -547,11 +547,11 @@ func main() { | `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | | `offset` | optionalnullable.OptionalNullable[`int64`] | :heavy_minus_sign: | Number of records to skip for pagination | 0 | | `limit` | `*int64` | :heavy_minus_sign: | Maximum number of records to return (max 100) | 50 | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*operations.ListWorkspaceMembersResponse](../../models/operations/listworkspacemembersresponse.mdx), error** +**[*operations.ListWorkspaceMembersResponse](../../models/operations/listworkspacemembersresponse), error** ### Errors @@ -608,12 +608,12 @@ func main() { | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `bulkAddWorkspaceMembersRequest` | [components.BulkAddWorkspaceMembersRequest](../../models/components/bulkaddworkspacemembersrequest) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.BulkAddWorkspaceMembersResponse](../../models/components/bulkaddworkspacemembersresponse.mdx), error** +**[*components.BulkAddWorkspaceMembersResponse](../../models/components/bulkaddworkspacemembersresponse), error** ### Errors @@ -671,12 +671,12 @@ func main() { | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | | `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | | | `id` | `string` | :heavy_check_mark: | The workspace ID (UUID) or slug | production | -| `bulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest.mdx) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | -| `opts` | [][operations.Option](../../models/operations/option.mdx) | :heavy_minus_sign: | The options for this request. | | +| `bulkRemoveWorkspaceMembersRequest` | [components.BulkRemoveWorkspaceMembersRequest](../../models/components/bulkremoveworkspacemembersrequest) | :heavy_check_mark: | N/A | \{
"user_ids": [
"user_abc123",
"user_def456"
]
} | +| `opts` | [][operations.Option](../../models/operations/option) | :heavy_minus_sign: | The options for this request. | | ### Response -**[*components.BulkRemoveWorkspaceMembersResponse](../../models/components/bulkremoveworkspacemembersresponse.mdx), error** +**[*components.BulkRemoveWorkspaceMembersResponse](../../models/components/bulkremoveworkspacemembersresponse), error** ### Errors diff --git a/scripts/fix-docs-links.sh b/scripts/fix-docs-links.sh new file mode 100755 index 00000000..f5e0546a --- /dev/null +++ b/scripts/fix-docs-links.sh @@ -0,0 +1,53 @@ +#!/usr/bin/env bash +# Strip the `.mdx` extension from cross-references in the docs Speakeasy emits +# under docs/. +# +# Mintlify serves every page at an extensionless path, so a generated link like +# `[operations.Foo](../../models/operations/foo.mdx)` 404s while +# `[operations.Foo](../../models/operations/foo)` resolves. Speakeasy emits the +# extension, so rewrite it after every `speakeasy run`. +# +# Idempotent: no offending links -> no file changes. Pass --check to report +# offending files and exit non-zero without editing (for CI). +# +# Requires: bash, grep, sed. No network, no toolchain. +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +cd "$ROOT" + +DOCS_DIR="docs" +# Markdown link whose target ends in `.mdx`, with an optional `#anchor`. +LINK_PATTERN='\]\([^)]*\.mdx(#[^)]*)?\)' + +if [[ ! -d "$DOCS_DIR" ]]; then + echo "missing $DOCS_DIR/" >&2 + exit 1 +fi + +did_request_check=false +if [[ "${1:-}" == "--check" ]]; then + did_request_check=true +elif [[ $# -gt 0 ]]; then + echo "usage: $0 [--check]" >&2 + exit 2 +fi + +files=() +while IFS= read -r file; do + files+=("$file") +done < <(grep -rlE "$LINK_PATTERN" "$DOCS_DIR" --include='*.mdx' | sort) + +if ((${#files[@]} == 0)); then + echo "no .mdx link extensions in $DOCS_DIR/" + exit 0 +fi + +if [[ "$did_request_check" == true ]]; then + echo "found .mdx link extensions in ${#files[@]} file(s) — run scripts/fix-docs-links.sh" >&2 + printf '%s\n' "${files[@]}" >&2 + exit 1 +fi + +sed -i -E 's/\]\(([^)]*)\.mdx(#[^)]*)?\)/](\1\2)/g' "${files[@]}" +echo "stripped .mdx link extensions in ${#files[@]} file(s)"